From 9f4e07a64ab60f83451ae9391f23d3d4f9a0a388 Mon Sep 17 00:00:00 2001 From: Travis Delker Date: Wed, 2 Jul 2025 15:56:02 -0400 Subject: [PATCH 1/2] add OpenAPI for P6 with Basic and CLient Credentials Auth --- .../platform6-OAuth-ClientCreds.json | 79532 +++++++++++++++ Itential/Platform/OpenAPISpecs/platform6.json | 79608 ++++++++++++++++ 2 files changed, 159140 insertions(+) create mode 100644 Itential/Platform/OpenAPISpecs/platform6-OAuth-ClientCreds.json create mode 100644 Itential/Platform/OpenAPISpecs/platform6.json diff --git a/Itential/Platform/OpenAPISpecs/platform6-OAuth-ClientCreds.json b/Itential/Platform/OpenAPISpecs/platform6-OAuth-ClientCreds.json new file mode 100644 index 0000000..a6cdfe4 --- /dev/null +++ b/Itential/Platform/OpenAPISpecs/platform6-OAuth-ClientCreds.json @@ -0,0 +1,79532 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Oauth-Platform 6", + "description": "Platform 6 REST API for Application Integration.", + "version": "1.0.0", + "x-logo": { + "url": "https://www.itential.com/wp-content/uploads/2022/08/Color-Variation-White.png", + "backgroundColor": "#FFFFFF", + "altText": "Itential logo" + } + }, + "servers": [ + { + "url": "{protocol}://{server}:{port}", + "variables": { + "protocol": { + "default": "http", + "description": "The server protocol" + }, + "server": { + "default": "localhost", + "description": "The server IP or DNS" + }, + "port": { + "default": "3000", + "description": "The server port" + } + } + } + ], + "x-tagGroups": [ + { + "name": "Home", + "tags": ["home-about", "home-baseline"] + }, + { + "name": "Authentication", + "tags": ["auth-reqs", "auth-basic", "auth-query-token", "auth-client"] + }, + { + "name": "Getting Started", + "tags": [ + "example-whoami-basic", + "example-whoami-query-token", + "example-whoami-client-bearer-token" + ] + }, + { + "name": "API Reference", + "tags": [ + "api-reference", + "adapter-models", + "adapters", + "ag-manager", + "applications", + "authentication", + "authorization", + "automation-studio", + "configuration_manager", + "customization", + "device-counts", + "external-links", + "git", + "group-mappings", + "health", + "help", + "indexes", + "integration-models", + "integrations", + "json-forms", + "lifecycle-manager", + "mop", + "oauth", + "operations-manager", + "profiles", + "schema", + "search", + "sso", + "tags", + "template_builder", + "transformations", + "user", + "workflow_builder", + "workflow_engine" + ] + } + ], + "tags": [ + { + "name": "home-about", + "x-displayName": "About", + "description": "The Itential REST API uses OpenAPI 3.1.0 specifications and supports Basic Authentication and OAuth 2.0 to authenticate requests. This reference library documents available APIs for the Platform 6, including HTTP response codes to indicate success or failure of an API request. Platform 6 REST APIs also use standard verbs to perform CRUD operations. For product documentation, visit [Itential Documentation & Guides](https://docs.itential.com/v1/en).\n
" + }, + { + "name": "home-baseline", + "x-displayName": "Ports and Base Path", + "description": "Default HTTP port is `3000`. Default HTTPS port is `3443`. Both IPv6 and IPv4 are supported. Default host is `127.0.0.1`. The basePath is `/`.\n
\n" + }, + { + "name": "auth-reqs", + "x-displayName": "Authentication", + "description": "API requests without authentication will fail. Available authorizations include: `BasicAuth` (username/password), `CookieAuth`(token/cookie-based) and `OAuth` (token/query-based).\n
\n" + }, + { + "name": "auth-basic", + "x-displayName": "Basic Auth", + "description": "

This API uses Basic Authentication for securing its endpoints.

\n\n

How to Use Basic Authentication

\n

Using this authentication strategy, you need to provide your credentials in the HTTP request headers. The credentials should be sent as a base64 encoded string of username:password.

\n\n

Example: Using curl for Basic Authentication

\n
\n curl -u username:password -X GET \"https://localhost:3443\"\n
\n\n

In this example, -u is the flag used by curl to specify the username and password. Replace username and password with your actual credentials.

\n\n

HTTP Request Headers

\n

The Basic Authentication credentials are sent in the Authorization header. Here's what it looks like:

\n
\n Authorization: Basic base64(username:password)\n
\n\n

Base64 Encoding

\n

The username:password string needs to be base64 encoded before it is sent in the header. For example, if your username is user and your password is pass, the string to encode is user:pass. The base64 encoded result would look something like this:

\n
\n Authorization: Basic dXNlcjpwYXNz\n
\n" + }, + { + "name": "auth-query-token", + "x-displayName": "Query Token", + "description": "

Authentication

\n

Using this authentication strategy, you need to authenticate and obtain a token by making a POST request to the /login endpoint. The response token will be used in the token query parameter for subsequent requests.

\n\n

How to Request a Token

\n

To obtain an authentication token, send a POST request to the /login endpoint with the following JSON payload:

\n\n
\n \n {\n \"user\": {\n \"username\": \"admin\",\n \"password\": \"admin\"\n }\n }\n \n
\n\n

Example: Using curl to Request a Token

\n
\n curl -X POST \"https://localhost:3443/login\" -H \"Content-Type: application/json\" -d '{\"user\": {\"username\": \"admin\", \"password\": \"admin\"}}'\n
\n\n

In this example, the -d flag is used by curl to send the JSON body with the request.

\n\n

Response

\n

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

\n\n
\n \n your-auth-token-here\n \n
\n\n

Using the Token in Subsequent Requests

\n

Once you have the token, include it in the query string of your requests as follows:

\n\n
\n ?token=your-auth-token-here\n
\n" + }, + { + "name": "auth-client", + "x-displayName": "Client Auth", + "description": "

Authentication

\n

Using this authentication strategy, you need to authenticate and obtain a Bearer token by making a POST request to the /oauth/token endpoint. The response access_token will be used as temporary credentials that the client will set in the Authorization header. Here's what it looks like:

\n
\n Authorization: Basic access_token\n
\n\n.

\n\n

How to Request a Token

\n

To obtain an authentication token, send a POST request to the /oauth/token endpoint. You'll need to send the data as application/x-www-form-urlencoded with the following payload:

\n\n
\n client_id=your-client-id&client_secret=your-client-secret&grant_type=client_credentials\n
\n\n

Example: Using curl to Request a Bearer Token

\n
\n curl -X POST \"https://localhost:3443/oauth/token\" -H \"Content-Type: accept: application/json\" -H \"Content-Type: application/x-www-form-urlencoded\" -d 'client_id=123abccc123a123a12ab1ab1&client_secret=a123a123-a1a1-1a1a-a123-123a12abc1a1&grant_type=client_credentials'\n
\n\n

In this example, the -d flag is used by curl to send the data with the request.

\n\n

Response

\n

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

\n\n
\n\n{\n\"access_token\": \"falksjflkasdjflkasdjfklajsdflj.eyJwcmluY2lwYWxJZCI6IjY2OWU1ZGNjOTE1ZDUxMWEzMmJmMGNhNCIsImV4cCI6MTcyMTY1OTQ4MDkwMiwiaWF0IjoxNzIxNjU1ODgwfQ.7jrB2mC9aqSdPdUvz7D-u9HghRFtnpFbYdaBH54kNZc\",\"token_type\": \"bearer\",\"expires_in\": 3600}\n \n
\n\n

Using the Bearer Token in Subsequent Requests

\n

Once you have the Bearer token, use it as your Authorization header. Here's what it should look like:

\n\n
\n Authorization: Bearer your-access_token-here\n
\n" + }, + { + "name": "example-whoami-basic", + "x-displayName": "Example (whoami) - Basic Auth", + "description": "To test the API using Basic Authentication, you can use the following\n`curl` command. Replace `username` and `password` with your actual\ncredentials.\n\nNote: Basic Auth is only available over SSL.\n\n\n
\n curl -u username:password -X GET \"https://localhost:3443/whoami\"\n
\n\nThis command sends a GET request to the specified resource, using the\nprovided username and password for authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" + }, + { + "name": "example-whoami-query-token", + "x-displayName": "Example (whoami) - Query Token", + "description": "To test the API using the Query Token Authentication, you can use the following\n`curl` command. Replace `your-auth-token-here` with your actual\ntoken that you received using `/login`.\n\n\n
\n curl -X GET \"https://localhost:3443/whoami?token=your-auth-token-here\"\n
\n\nThis command sends a GET request to the specified resource, using the\nQuery Token authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" + }, + { + "name": "example-whoami-client-bearer-token", + "x-displayName": "Example (whoami) - Client Bearer Token", + "description": "To test the API using the Client Authentication, you can use the following\n`curl` command. Replace `your-access_token-here` with your actual\nBearer token that you received using `/oauth/token`.\n\n\n
\n curl -X GET \"https://localhost:3443/whoami\" -H \"Authorization: Bearer your-access_token-here\" \n
\n\nThis command sends a GET request to the specified resource, using the\nClient authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" + }, + { + "name": "adapter-models", + "x-displayName": "Adapter Models" + }, + { + "name": "adapters", + "x-displayName": "Adapters" + }, + { + "name": "ag-manager", + "x-displayName": "Automation Gateway" + }, + { + "name": "applications", + "x-displayName": "Applications" + }, + { + "name": "authentication", + "x-displayName": "Authentication" + }, + { + "name": "authorization", + "x-displayName": "Authorization" + }, + { + "name": "automation-studio", + "x-displayName": "Automation Studio", + "description": "A suite of tools for designing workflows, templates, and forms." + }, + { + "name": "configuration_manager", + "description": "Unified manager application for devices and configurations" + }, + { + "name": "configuration_manager", + "x-displayName": "Configuration Manager" + }, + { + "name": "customization", + "x-displayName": "Customization" + }, + { + "name": "device-counts", + "x-displayName": "Device Counts" + }, + { + "name": "external-links", + "x-displayName": "External Links" + }, + { + "name": "formbuilder", + "description": "API to generate dynamic forms" + }, + { + "name": "git", + "x-displayName": "Git" + }, + { + "name": "group-mappings", + "x-displayName": "Group Mappings" + }, + { + "name": "health", + "x-displayName": "Health" + }, + { + "name": "help", + "x-displayName": "Help", + "description": "Documentation Help" + }, + { + "name": "indexes", + "x-displayName": "Indexes" + }, + { + "name": "integration-models", + "x-displayName": "Integration Models" + }, + { + "name": "integrations", + "x-displayName": "Integrations" + }, + { + "name": "json-forms", + "x-displayName": "JSON Forms", + "description": "An application to create, edit, and publish forms based on JSON documents." + }, + { + "name": "lifecycle-manager", + "x-displayName": "Lifecycle Manager" + }, + { + "name": "mop", + "x-displayName": "Command Templates (MOP)" + }, + { + "name": "oauth", + "x-displayName": "OAuth" + }, + { + "name": "operations-manager", + "x-displayName": "Operations Manager" + }, + { + "name": "prebuilts", + "description": "Pre-Builts API" + }, + { + "name": "prebuilts-repository", + "description": "Pre-Builts Repository API" + }, + { + "name": "profiles", + "x-displayName": "Profiles" + }, + { + "name": "prometheus_metrics", + "x-displayName": "Prometheus Metrics" + }, + { + "name": "schema", + "x-displayName": "Schema" + }, + { + "name": "search", + "x-displayName": "Search" + }, + { + "name": "sso", + "x-displayName": "Single Sign On" + }, + { + "name": "tags", + "x-displayName": "Tags" + }, + { + "name": "template_builder", + "x-displayName": "Template Builder" + }, + { + "name": "transformations", + "x-displayName": "Transformations" + }, + { + "name": "user", + "x-displayName": "User" + }, + { + "name": "workflow_builder", + "x-displayName": "Workflow Builder" + }, + { + "name": "workflow_engine", + "x-displayName": "Workflow Engine" + } + ], + "paths": { + "/adapters": { + "post": { + "summary": "Create a new adapter.", + "description": "Create a new adapter in IAP.", + "tags": ["adapters"], + "parameters": [], + "operationId": "Adapters.createAdapter", + "responses": { + "200": { + "description": "The result of the adapter creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "model": { + "$ref": "#/components/schemas/iap_services-schema_model" + }, + "name": { + "$ref": "#/components/schemas/iap_services-schema_name" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "id", + "description": "The id for the service", + "const": { + "$data": "2/name" + }, + "examples": ["Local AAA"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of an adapter", + "examples": ["local_aaa", "Redis", "Email"] + }, + "properties": { + "type": "object", + "properties": {} + }, + "brokers": { + "type": "array", + "description": "Brokers which utilize this service", + "items": { + "type": "string", + "description": "Name of the broker", + "examples": ["aaa"] + } + }, + "groups": { + "type": "array", + "description": "Groups which can use this service", + "items": { + "type": "string", + "description": "Name of the group", + "examples": ["pronghorn_admin"] + } + } + }, + "required": ["id", "type"] + } + }, + "required": ["name", "type", "properties"] + } + } + } + } + } + } + }, + "get": { + "summary": "Get all adapters.", + "description": "Get all adapters in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "skipActiveSync", + "in": "query", + "description": "skipActiveSync", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + } + ], + "operationId": "Adapters.getAdapters", + "responses": { + "200": { + "description": "Contains an array of adapters and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": false + } + }, + "/adapters/import": { + "post": { + "summary": "Import a new adapter.", + "description": "Import a new adapter in IAP.", + "tags": ["adapters"], + "parameters": [], + "operationId": "Adapters.importAdapter", + "responses": { + "200": { + "description": "The result of the adapter import process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "model": { + "$ref": "#/components/schemas/iap_services-schema_model" + }, + "name": { + "$ref": "#/components/schemas/iap_services-schema_name" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "migrationVersion": { + "type": "integer", + "minimum": 0 + }, + "properties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "id", + "description": "The id for the service", + "const": { + "$data": "2/name" + }, + "examples": ["Local AAA"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of an adapter", + "examples": ["local_aaa", "Redis", "Email"] + }, + "properties": { + "type": "object", + "properties": {} + }, + "brokers": { + "type": "array", + "description": "Brokers which utilize this service", + "items": { + "type": "string", + "description": "Name of the broker", + "examples": ["aaa"] + } + }, + "groups": { + "type": "array", + "description": "Groups which can use this service", + "items": { + "type": "string", + "description": "Name of the group", + "examples": ["pronghorn_admin"] + } + } + }, + "required": ["id", "type"] + } + }, + "required": ["name", "type", "properties"] + } + } + } + } + } + } + } + }, + "/adapters/{name}": { + "delete": { + "summary": "Delete an adapter.", + "description": "Delete an adapter from IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.deleteAdapter", + "responses": { + "200": { + "description": "The output of the adapter deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a single adapter.", + "description": "Get a single adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.getAdapter", + "responses": { + "200": { + "description": "Contains the data of a single adapter.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an adapter.", + "description": "Update an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.updateAdapter", + "responses": { + "200": { + "description": "The output of the adapter update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "$ref": "#/components/schemas/iap_services-schema_properties" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/adapters/{name}/export": { + "get": { + "summary": "Export a single adapter.", + "description": "Export a single adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.exportAdapter", + "responses": { + "200": { + "description": "Contains the data of a single adapter.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": false + } + }, + "/adapters/{name}/changelogs": { + "get": { + "summary": "Get the list of changelogs.", + "description": "Get the list of changelogs for a specific adapter.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["WorkFlowEngine", "MOP"] + } + }, + { + "name": "release", + "in": "query", + "description": "release", + "required": false, + "schema": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + } + } + ], + "operationId": "Adapters.getAdapterChangelogs", + "responses": { + "200": { + "description": "The list of changelogs available for the requested adapter.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "string", + "examples": [ + { + "2020.1.1": "Changelog for 2020.1" + } + ], + "pattern": "^[0-9]{4}[.][0-9]{1,}[.][0-9]{1,}$" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": true + } + }, + "/adapters/{name}/start": { + "put": { + "summary": "Start an adapter.", + "description": "Start an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.startAdapter", + "responses": { + "200": { + "description": "The result of the start process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin"] + } + ], + "deprecated": false + } + }, + "/adapters/{name}/stop": { + "put": { + "summary": "Stop an adapter.", + "description": "Stop an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.stopAdapter", + "responses": { + "200": { + "description": "The result of the stop process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin"] + } + ], + "deprecated": false + } + }, + "/adapters/{name}/restart": { + "put": { + "summary": "Restart an adapter.", + "description": "Restart an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.restartAdapter", + "responses": { + "200": { + "description": "The result of the restart process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin"] + } + ], + "deprecated": false + } + }, + "/adapters/{name}/loglevel": { + "put": { + "summary": "Update the log levels.", + "description": "Update the log levels for an adapter.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.updateAdapterLogging", + "responses": { + "200": { + "description": "The result of updating the log levels for an adapter.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "transport": { + "type": "string", + "enum": ["file", "console", "syslog"] + } + }, + "if": { + "properties": { + "transport": { + "const": "syslog" + } + } + }, + "then": { + "properties": { + "level": { + "$ref": "#/components/schemas/iap_services-schema_sys_log_level" + } + } + }, + "else": { + "properties": { + "level": { + "$ref": "#/components/schemas/iap_services-schema_log_level" + } + } + } + } + } + } + } + } + } + } + }, + "/adapters/{name}/properties": { + "put": { + "summary": "Update the properties of an adapter.", + "description": "Update the properties of an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.updateAdapterProperties", + "responses": { + "200": { + "description": "The output of the adapter properties update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties" + } + } + } + } + } + } + } + }, + "/adapters/brokers/mapping": { + "get": { + "summary": "Get a mapping between brokers and adapters.", + "description": "Get a mapping between brokers and adapters.", + "tags": ["adapters"], + "parameters": [], + "operationId": "Adapters.getBrokerMap", + "responses": { + "200": { + "description": "Mapping between brokers and adapters in IAP.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": [ + { + "aaa": ["Local AAA"] + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": false + } + }, + "/whoami": { + "get": { + "summary": "Gets the authorization data for the logged in user", + "description": "Gets the authorization data for the logged in user", + "tags": ["authentication"], + "parameters": [ + { + "name": "roles", + "in": "query", + "description": "roles", + "required": false, + "schema": { + "type": "string", + "enum": ["names", "ids"] + } + } + ], + "operationId": "Authentication.whoAmI", + "responses": { + "200": { + "description": "Authorization data for a user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "type": "string", + "description": "The name of the AAA adapter from which the user logged in", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "description": "The username of the logged in user", + "examples": ["jane_doe"] + }, + "firstname": { + "type": "string", + "description": "The first name of the logged in user", + "examples": ["Jane"] + }, + "groups": { + "type": "array", + "description": "An array of groups which contain the logged in user", + "items": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "type": "string", + "description": "The name of the AAA adapter which contains the group", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "description": "The name of the group", + "examples": ["admin_group"] + } + } + } + }, + "roles": { + "type": "array", + "description": "Array of roles user has access to", + "items": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + }, + "roleNames": { + "type": "array", + "description": "Array of role names that user has access to", + "items": { + "type": "string" + } + }, + "routes": { + "type": "array", + "description": "Array of routes logged in user has access to", + "items": { + "type": "string", + "examples": ["/admin/"] + } + }, + "methods": { + "type": "object", + "description": "Map of service names and method names which the user has access to", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The name of a method within an application", + "examples": ["getProfiles"] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/mySession": { + "get": { + "summary": "Gets the session document for the active user", + "description": "Gets the session for the active user", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getMySession", + "responses": { + "200": { + "description": "The session document for the logged in user.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The session token for the logged in user" + }, + "loginMethod": { + "type": "string", + "description": "The way a user logged in", + "enum": ["Web", "sudo"] + }, + "session_start": { + "type": "integer", + "description": "The Unix epoch time when the session started" + }, + "ttl": { + "type": "integer", + "description": "The default ttl for a user session" + }, + "principalId": { + "type": "string", + "description": "The accountId for the logged in user" + }, + "requestCount": { + "type": "integer", + "description": "The number of API requests made during the active session" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/myPrincipal": { + "get": { + "summary": "Gets the principal document for the active user", + "description": "Gets the principal for the active user", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getMyPrincipal", + "responses": { + "200": { + "description": "The principal document for the logged in user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "type": "string", + "description": "The name of the AAA adapter from which the user logged in", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "description": "The username of the logged in user", + "examples": ["jane_doe"] + }, + "firstname": { + "type": "string", + "description": "The first name of the logged in user", + "examples": ["Jane"] + }, + "groups": { + "type": "array", + "description": "An array of groups which contain the logged in user", + "items": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "type": "string", + "description": "The name of the AAA adapter which contains the group", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "description": "The name of the group", + "examples": ["admin_group"] + } + } + } + }, + "roles": { + "type": "array", + "description": "Array of roles user has access to", + "items": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + }, + "roleNames": { + "type": "array", + "description": "Array of role names user has access to", + "items": { + "type": "string" + } + }, + "allowedMethods": { + "type": "array", + "description": "The API methods which a user has access to", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "description": "The service which contains the method", + "examples": ["AutomationStudio"] + }, + "name": { + "type": "string", + "description": "The name of the method", + "examples": ["getTemplates"] + } + } + } + }, + "allowedViews": { + "type": "array", + "description": "The URL pages which a user has access to", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "description": "The service which contains the view", + "examples": ["AutomationStudio"] + }, + "path": { + "type": "string", + "description": "The URL route to the view", + "examples": ["/automation-studio/"] + } + } + } + }, + "routes": { + "type": "array", + "description": "Array of routes logged in user has access to", + "items": { + "type": "string", + "examples": ["/admin/"] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/myTtl": { + "get": { + "summary": "Get the number of seconds until the logged in user's session expires.", + "description": "Get the number of seconds until the user is logged out.", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getMyTtl", + "responses": { + "200": { + "description": "The number of seconds until the logged in user's session expires", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "integer" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/sso": { + "get": { + "summary": "Log in and create a session in IAP using single sign on", + "description": "Log into IAP using single sign on", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.sso", + "responses": { + "200": { + "description": "No output.", + "content": { + "application/json": { + "schema": {} + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/sso/test/{name}": { + "get": { + "summary": "Test logging into IAP using a saved single sign on configuration", + "description": "Test logging into IAP using single sign on", + "tags": ["authentication"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "Authentication.ssoTest", + "responses": { + "200": { + "description": "No output.", + "content": { + "application/json": { + "schema": {} + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/saml/callback": { + "post": { + "summary": "This the route used by the SAML identity provider to callback to IAP with the authentication response. This is not meant for manual use.", + "description": "Callback used by the SAML identity provider", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.samlCallback", + "responses": { + "200": { + "description": "No output.", + "content": { + "application/json": { + "schema": {} + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/sso/enabled": { + "get": { + "summary": "Get whether or not single sign on is enabled", + "description": "Get whether or not single sign on is enabled", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.isSSOEnabled", + "responses": { + "200": { + "description": "Whether or not single sign on is enabled", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/login": { + "post": { + "summary": "Log in an create a session in IAP", + "description": "Log in to IAP", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.login", + "responses": { + "200": { + "description": "The session token for a logged in user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string", + "examples": ["MTQ4ZmMzMGMxOTQ2MTg4N2ZjMDhiMTY0MzlkYTgwZmM="] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false, + "requestBody": { + "description": "credentials", + "content": { + "application/json": { + "schema": { + "title": "credentials", + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/logout": { + "get": { + "summary": "Log out of IAP and delete current session", + "description": "Log out of IAP", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.logout", + "responses": { + "200": { + "description": "The return data from logging out", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string", + "examples": ["You have successfully logged out."] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/download": { + "get": { + "summary": "Download a public file from IAP", + "description": "Download a public file from IAP", + "tags": ["authentication"], + "parameters": [ + { + "name": "file_name", + "in": "query", + "description": "file_name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "operationId": "Authentication.download", + "responses": { + "200": { + "description": "The contents of the file downloaded", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string", + "examples": ["this is the contents of a file"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/system/id": { + "get": { + "summary": "Get system server id.", + "description": "Get system server id for the current IAP.", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getSystemId", + "responses": { + "200": { + "description": "serverId of the current IAP.", + "content": { + "application/json": { + "schema": { + "title": "serverId", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/version": { + "get": { + "summary": "Get verion.", + "description": "Get release verion of current IAP.", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getReleaseVersion", + "responses": { + "200": { + "description": "Release Version of the current IAP.", + "content": { + "application/json": { + "schema": { + "title": "releaseVersion", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/config/apps": { + "get": { + "summary": "Get all application configs in IAP.", + "description": "Get all application configs in IAP.", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getApplicationConfigs", + "responses": { + "200": { + "description": "Contains the configuration of all applications.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "title": "id", + "type": "string" + }, + "export": { + "title": "export", + "type": "string" + }, + "title": { + "title": "title", + "type": "string" + }, + "type": { + "title": "type", + "type": "string" + }, + "summary": { + "title": "summary", + "type": "string" + }, + "pdb": { + "title": "pdb", + "type": "boolean" + }, + "roles": { + "title": "roles", + "type": "array", + "items": { + "type": "string" + } + }, + "methods": { + "title": "methods", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "description": { + "title": "description", + "type": "string" + }, + "summary": { + "title": "summary", + "type": "string" + }, + "deprecated": { + "title": "deprecated", + "type": "boolean" + }, + "roles": { + "title": "roles", + "type": "array", + "items": { + "type": "string" + } + }, + "route": { + "title": "route", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string" + }, + "verb": { + "title": "verb", + "type": "string" + } + } + }, + "input": { + "title": "input", + "type": "array", + "items": { + "type": "object" + } + }, + "output": { + "title": "output", + "type": "object" + } + } + } + }, + "views": { + "title": "views", + "type": "array", + "items": { + "type": "object" + } + }, + "src": { + "title": "src", + "type": "string" + }, + "encrypted": { + "title": "encrypted", + "type": "boolean" + }, + "version": { + "title": "version", + "type": "string" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/profile/{username}": { + "get": { + "summary": "Gets the user profile for the active user", + "description": "Gets the user profile for the active user", + "tags": ["authentication"], + "parameters": [ + { + "name": "username", + "in": "path", + "description": "The exact username for the logged in user", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema_username" + } + } + ], + "operationId": "Authentication.getUserProfile", + "responses": { + "200": { + "description": "The account document for the logged in user.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": true + } + }, + "/profile/update": { + "put": { + "summary": "Updates the user profile for the active user", + "description": "Updates the user profile for the active user", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.updateUserProfile", + "responses": { + "200": { + "description": "Updated account document for current user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": true, + "requestBody": { + "description": "userProfile", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "username": { + "$ref": "#/components/schemas/iap_accounts-schema_username" + }, + "email": { + "$ref": "#/components/schemas/iap_accounts-schema_email" + } + }, + "required": ["username"], + "additionalProperties": false + } + } + } + } + } + }, + "/adapter-models/types": { + "get": { + "summary": "Get the list of available adapter model types.", + "description": "Get the list of available adapter model types in the current IAP.", + "tags": ["adapter-models"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["profile1"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["profile1"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["profile"] + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "AdapterModels.getAdapterModelTypes", + "responses": { + "200": { + "description": "Contains an array of adapter model types and the total.", + "content": { + "application/json": { + "schema": { + "title": "adapterModels", + "type": "object", + "required": ["adapterModels", "total"], + "properties": { + "adapterModels": { + "type": "array", + "items": { + "type": "string", + "examples": ["local_aaa", "redis"] + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AdapterModels.admin", "AdapterModels.apiread"], + "CookieAuth": ["AdapterModels.admin", "AdapterModels.apiread"], + "BasicAuth": ["AdapterModels.admin", "AdapterModels.apiread"] + } + ], + "deprecated": false + } + }, + "/integration-models": { + "post": { + "summary": "Create a new integration model.", + "description": "Create a new integration model in IAP.", + "tags": ["integration-models"], + "parameters": [], + "operationId": "IntegrationModels.createIntegrationModel", + "responses": { + "200": { + "description": "The output of the integration model creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "type": "object", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "model": { + "title": "model", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + } + }, + "get": { + "summary": "Get all integration models.", + "description": "Get all the integration models in IAP.", + "tags": ["integration-models"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "Filter the response based on each item that includes the provided query.", + "required": false, + "schema": { + "type": "string", + "description": "Filter the response based on each item that includes the provided query.", + "examples": ["git", "hub", "v5"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "enum": ["versionId"] + } + }, + { + "name": "equals", + "in": "query", + "description": "Filter the response based on each item that is an exact match to the provided query.", + "required": false, + "schema": { + "type": "string", + "description": "Filter the response based on each item that is an exact match to the provided query.", + "examples": ["GitHub:v5"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "enum": ["versionId"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "Filter the response based on each item that starts with the provided query.", + "required": false, + "schema": { + "type": "string", + "description": "Filter the response based on each item that starts with the provided query.", + "examples": ["g"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "enum": ["versionId"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by. Default is versionId.", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by. Default is versionId.", + "enum": ["versionId"] + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "IntegrationModels.getIntegrationModels", + "responses": { + "200": { + "description": "Contains the data for all integration models.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "integrationModels": { + "type": "object", + "properties": { + "model": { + "type": "string", + "examples": ["@itential/adapter_GitHub:v5"] + }, + "versionId": { + "type": "string", + "examples": ["GitHub:v5"] + }, + "description": { + "type": "string", + "examples": [ + "A standard description about the integration model" + ] + }, + "properties": { + "type": "object", + "description": "Refer to OpenAPI specifications for the available properties for this OpenAPI document." + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ], + "CookieAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ], + "BasicAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an integration model.", + "description": "Update an integration model in IAP.", + "tags": ["integration-models"], + "parameters": [], + "operationId": "IntegrationModels.updateIntegrationModel", + "responses": { + "200": { + "description": "The output of the update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "type": "object", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "model": { + "title": "model", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + } + } + }, + "/integration-models/{name}": { + "delete": { + "summary": "Delete an integration model.", + "description": "Delete an integration model from IAP.", + "tags": ["integration-models"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the integration model.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["GitHub:v5"] + } + } + ], + "operationId": "IntegrationModels.deleteIntegrationModel", + "responses": { + "200": { + "description": "The output of the integration model deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a specific integration model.", + "description": "Get a specific integration model in IAP.", + "tags": ["integration-models"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the integration model.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["Gitlab:v5"] + } + } + ], + "operationId": "IntegrationModels.getIntegrationModel", + "responses": { + "200": { + "description": "Contains the data for a specific integration model.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "model": { + "type": "string", + "examples": ["@itential/adapter_GitHub:v5"] + }, + "versionId": { + "type": "string", + "examples": ["GitHub:v5"] + }, + "description": { + "type": "string", + "examples": [ + "A standard description about the integration model" + ] + }, + "properties": { + "type": "object", + "description": "Refer to OpenAPI specifications for the available properties for this OpenAPI document." + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ], + "CookieAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ], + "BasicAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ] + } + ], + "deprecated": false + } + }, + "/integration-models/{name}/export": { + "get": { + "summary": "Export an integration model.", + "description": "Export an integration model's open API spec.", + "tags": ["integration-models"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the integration model.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["GitHub:v5"] + } + } + ], + "operationId": "IntegrationModels.exportIntegrationModel", + "responses": { + "200": { + "description": "The integration model open api spec.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document.", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false + } + }, + "/integration-models/{name}/securitySchemes": { + "get": { + "summary": "Gets an integration model's security schemes.", + "description": "Projection simplification for exportIntegrationModel", + "tags": ["integration-models"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the integration model.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["GitHub:v5"] + } + } + ], + "operationId": "IntegrationModels.getIntegrationModelSecuritySchemes", + "responses": { + "200": { + "description": "The integration model's security schemes according to its open api spec.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "description": "Refer to OpenAPI specifications for the structure of the security schemes of an OpenAPI document.", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false + } + }, + "/integration-models/validation": { + "put": { + "summary": "Validate an integration model.", + "description": "Validate an integration model.", + "tags": ["integration-models"], + "parameters": [], + "operationId": "IntegrationModels.validateIntegrationModel", + "responses": { + "200": { + "description": "The output of the integration model validation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "description": "Message containing either confirmation that the OpenAPI document is valid or validation errors related to the OpenAPI document.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "model": { + "title": "model", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + } + } + }, + "/integrations": { + "post": { + "summary": "Create a new integration.", + "description": "Create a new integration in IAP.", + "tags": ["integrations"], + "parameters": [], + "operationId": "Integrations.createIntegration", + "responses": { + "200": { + "description": "The result of the integration creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "model": { + "$ref": "#/components/schemas/iap_services-schema_model" + }, + "name": { + "$ref": "#/components/schemas/iap_services-schema_name" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "$ref": "#/components/schemas/iap_services-schema_properties" + }, + "virtual": { + "$ref": "#/components/schemas/iap_services-schema_virtual" + } + }, + "required": ["name", "type", "properties", "virtual"] + } + } + } + } + } + } + }, + "get": { + "summary": "Get all integrations.", + "description": "Get all integrations in IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["GitHub"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["GitHub"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["GitHub"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "skipActiveSync", + "in": "query", + "description": "skipActiveSync", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + } + ], + "operationId": "Integrations.getIntegrations", + "responses": { + "200": { + "description": "Contains an array of integrations and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Integrations.admin", "Integrations.apiread"], + "CookieAuth": ["Integrations.admin", "Integrations.apiread"], + "BasicAuth": ["Integrations.admin", "Integrations.apiread"] + } + ], + "deprecated": false + } + }, + "/integrations/{name}": { + "delete": { + "summary": "Delete an integration.", + "description": "Delete an integration from IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.deleteIntegration", + "responses": { + "200": { + "description": "The output of the integration deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a single integration.", + "description": "Get a single integration in IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.getIntegration", + "responses": { + "200": { + "description": "Contains the data of a single integration.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Integrations.admin", "Integrations.apiread"], + "CookieAuth": ["Integrations.admin", "Integrations.apiread"], + "BasicAuth": ["Integrations.admin", "Integrations.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an integration.", + "description": "Update an integration in IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Contains the name for the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.updateIntegration", + "responses": { + "200": { + "description": "The output of the integration update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "$ref": "#/components/schemas/iap_services-schema_properties" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/integrations/{name}/authCode": { + "post": { + "summary": "Posts an access token with an Authorization Code", + "description": "Initiates the Authorization Code exchange for an access token and stores the change", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.postAuthFlowAccessToken", + "responses": { + "200": { + "description": "The success of the operation", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "description": "Some description", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorizationCode": { + "title": "authorizationCode", + "type": "string" + }, + "redirectUri": { + "title": "redirectUri", + "type": "string" + } + } + } + } + } + } + } + }, + "/integrations/{name}/properties": { + "put": { + "summary": "Update the properties of an integration.", + "description": "Update the properties of an integration in IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.updateIntegrationProperties", + "responses": { + "200": { + "description": "The output of the integration properties update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties" + } + } + } + } + } + } + } + }, + "/server/config": { + "get": { + "summary": "Get the full IAP configuration.", + "description": "Returns the full IAP configuration, with value/origin definitions for each property.", + "tags": ["server"], + "parameters": [], + "operationId": "Server.getConfig", + "responses": { + "200": { + "description": "The full IAP configuration.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "array", + "items": { + "type": "object", + "required": ["name", "value", "origin"], + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": [ + "null", + "string", + "boolean", + "number", + "object", + "array" + ] + }, + "origin": { + "type": "string" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Server.admin", "Server.apiread"], + "CookieAuth": ["Server.admin", "Server.apiread"], + "BasicAuth": ["Server.admin", "Server.apiread"] + } + ], + "deprecated": false + } + }, + "/server/config/{key}": { + "get": { + "summary": "Get a single IAP configuration property.", + "description": "Returns a single IAP configuration property, with value/origin definitions.", + "tags": ["server"], + "parameters": [ + { + "name": "key", + "in": "path", + "description": "The configuration property key.", + "required": true, + "schema": {} + } + ], + "operationId": "Server.getConfigProperty", + "responses": { + "200": { + "description": "The value and origin of the requested property.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "required": ["name", "value", "origin"], + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": [ + "null", + "string", + "boolean", + "number", + "object", + "array" + ] + }, + "origin": { + "type": "string" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Server.admin", "Server.apiread"], + "CookieAuth": ["Server.admin", "Server.apiread"], + "BasicAuth": ["Server.admin", "Server.apiread"] + } + ], + "deprecated": false + } + }, + "/applications/{name}": { + "get": { + "summary": "Get a single application.", + "description": "Get a single application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.getApplication", + "responses": { + "200": { + "description": "Contains the data of a single application.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Applications.admin", "Applications.apiread"], + "CookieAuth": ["Applications.admin", "Applications.apiread"], + "BasicAuth": ["Applications.admin", "Applications.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an application.", + "description": "Update an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.updateApplication", + "responses": { + "200": { + "description": "The output of the application update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "$ref": "#/components/schemas/iap_services-schema_properties" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/applications/{name}/changelogs": { + "get": { + "summary": "Get the list of changelogs.", + "description": "Get the list of changelogs for a specific application.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + }, + { + "name": "release", + "in": "query", + "description": "release", + "required": false, + "schema": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + } + } + ], + "operationId": "Applications.getApplicationChangelogs", + "responses": { + "200": { + "description": "The list of changelogs available for the requested application.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "string", + "examples": [ + { + "2020.1.1": "Changelog for 2020.1" + } + ], + "pattern": "^[0-9]{4}[.][0-9]{1,}[.][0-9]{1,}$" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Applications.admin", "Applications.apiread"], + "CookieAuth": ["Applications.admin", "Applications.apiread"], + "BasicAuth": ["Applications.admin", "Applications.apiread"] + } + ], + "deprecated": true + } + }, + "/applications": { + "get": { + "summary": "Get all applications.", + "description": "Get all applications in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Applications.getApplications", + "responses": { + "200": { + "description": "Contains an array of applications and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "oneOf": [ + { + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + } + }, + { + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + } + } + } + ] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Applications.admin", "Applications.apiread"], + "CookieAuth": ["Applications.admin", "Applications.apiread"], + "BasicAuth": ["Applications.admin", "Applications.apiread"] + } + ], + "deprecated": false + } + }, + "/applications/{name}/start": { + "put": { + "summary": "Start an application.", + "description": "Start an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.startApplication", + "responses": { + "200": { + "description": "The result of the start process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false + } + }, + "/applications/{name}/stop": { + "put": { + "summary": "Stop an application.", + "description": "Stop an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.stopApplication", + "responses": { + "200": { + "description": "The result of the stop process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false + } + }, + "/applications/{name}/restart": { + "put": { + "summary": "Restart an application.", + "description": "Restart an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.restartApplication", + "responses": { + "200": { + "description": "The result of the restart process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false + } + }, + "/applications/{name}/loglevel": { + "put": { + "summary": "Update the log levels.", + "description": "Update the log levels for an application.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.updateApplicationLogging", + "responses": { + "200": { + "description": "The result of updating the log levels for an application.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "transport": { + "type": "string", + "enum": ["file", "console", "syslog"] + } + }, + "if": { + "properties": { + "transport": { + "const": "syslog" + } + } + }, + "then": { + "properties": { + "level": { + "$ref": "#/components/schemas/iap_services-schema_sys_log_level" + } + } + }, + "else": { + "properties": { + "level": { + "$ref": "#/components/schemas/iap_services-schema_log_level" + } + } + } + } + } + } + } + } + } + } + }, + "/applications/{name}/properties": { + "put": { + "summary": "Update the properties of an application.", + "description": "Update the properties of an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.updateApplicationProperties", + "responses": { + "200": { + "description": "The output of the application properties update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties" + } + } + } + } + } + } + } + }, + "/user/settings": { + "get": { + "summary": "Gets the user settings for the active user", + "description": "Gets the user settings for the active user", + "tags": ["user"], + "parameters": [], + "operationId": "UserSettings.getUserSettings", + "responses": { + "200": { + "description": "The account document for the logged in user.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Updates the user settings for the active user", + "description": "Updates the user settings for the active user", + "tags": ["user"], + "parameters": [], + "operationId": "UserSettings.updateUserSettings", + "responses": { + "200": { + "description": "Updated account document for current user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "type": "object", + "properties": { + "gitTokens": { + "$ref": "#/components/schemas/iap_accounts-schema_gitTokens" + }, + "email": { + "$ref": "#/components/schemas/iap_accounts-schema_email" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/schema/adapters/{name}": { + "get": { + "summary": "Get the adapter schema.", + "description": "Get the adapter schema.", + "tags": ["schema"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["redis", "email"] + } + } + ], + "operationId": "Schema.getAdapterSchema", + "responses": { + "200": { + "description": "Contains the schema for an adapter.", + "content": { + "application/json": { + "schema": { + "title": "schema", + "type": "object", + "properties": { + "schema": { + "$ref": "#/components/schemas/iap_services-schema" + }, + "decorators": { + "$ref": "#/components/schemas/iap_decorators-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Schema.admin", "Schema.apiread"], + "CookieAuth": ["Schema.admin", "Schema.apiread"], + "BasicAuth": ["Schema.admin", "Schema.apiread"] + } + ], + "deprecated": false + } + }, + "/schema/applications/{name}": { + "get": { + "summary": "Get the application schema.", + "description": "Get the application schema.", + "tags": ["schema"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["redis", "email"] + } + } + ], + "operationId": "Schema.getApplicationSchema", + "responses": { + "200": { + "description": "Contains the schema for an application.", + "content": { + "application/json": { + "schema": { + "title": "schema", + "type": "object", + "properties": { + "schema": { + "$ref": "#/components/schemas/iap_services-schema" + }, + "decorators": { + "$ref": "#/components/schemas/iap_decorators-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Schema.admin", "Schema.apiread"], + "CookieAuth": ["Schema.admin", "Schema.apiread"], + "BasicAuth": ["Schema.admin", "Schema.apiread"] + } + ], + "deprecated": false + } + }, + "/schema/integrations/{name}": { + "get": { + "summary": "Get the integration schema.", + "description": "Get the integration schema.", + "tags": ["schema"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected integration.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["ghv5", "ghv6"] + } + } + ], + "operationId": "Schema.getIntegrationSchema", + "responses": { + "200": { + "description": "Contains the schema for an integration.", + "content": { + "application/json": { + "schema": { + "title": "schema", + "type": "object", + "properties": { + "schema": { + "$ref": "#/components/schemas/iap_services-schema" + }, + "decorators": { + "$ref": "#/components/schemas/iap_decorators-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Schema.admin", "Schema.apiread"], + "CookieAuth": ["Schema.admin", "Schema.apiread"], + "BasicAuth": ["Schema.admin", "Schema.apiread"] + } + ], + "deprecated": false + } + }, + "/schema/profiles": { + "get": { + "summary": "Get the profile schema.", + "description": "Get the profile schema.", + "tags": ["schema"], + "parameters": [], + "operationId": "Schema.getProfileSchema", + "responses": { + "200": { + "description": "Contains the schema for profiles.", + "content": { + "application/json": { + "schema": { + "title": "schema", + "type": "object", + "properties": { + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema" + }, + "decorators": { + "$ref": "#/components/schemas/iap_decorators-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Schema.admin", "Schema.apiread"], + "CookieAuth": ["Schema.admin", "Schema.apiread"], + "BasicAuth": ["Schema.admin", "Schema.apiread"] + } + ], + "deprecated": false + } + }, + "/customization/banner": { + "get": { + "summary": "Get banner.", + "description": "Get banner for customization", + "tags": ["customization"], + "parameters": [], + "operationId": "Customization.getBanner", + "responses": { + "200": { + "description": "The banner object from the database", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/iap_banner-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update the banner.", + "description": "Update the banner", + "tags": ["customization"], + "parameters": [], + "operationId": "Customization.updateBanner", + "responses": { + "200": { + "description": "The result from the database", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Customization.admin"], + "CookieAuth": ["Customization.admin"], + "BasicAuth": ["Customization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_banner-schema" + } + } + } + } + } + }, + "/help/adapters/html": { + "get": { + "summary": "Generate documentation for adapters", + "description": "Generate an HTML documentation page for adapters", + "tags": ["help"], + "parameters": [], + "operationId": "Help.getAdaptersHtml", + "responses": { + "200": { + "description": "HTML string containing documentation for adapter functions.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/help/brokers/html": { + "get": { + "summary": "Generate documentation for brokers", + "description": "Generate an HTML documentation page for brokers", + "tags": ["help"], + "parameters": [], + "operationId": "Help.getBrokersHtml", + "responses": { + "200": { + "description": "HTML string containing documentation for broker functions.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/help/applications/html": { + "get": { + "summary": "Generate documentation for applications", + "description": "Generate an HTML documentation page for applications", + "tags": ["help"], + "parameters": [], + "operationId": "Help.getApplicationsHtml", + "responses": { + "200": { + "description": "HTML string containing documentation for application functions.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/help/openapi": { + "get": { + "summary": "Generate an OpenAPI v3 document for IAP", + "description": "Generate an OpenAPI v3.1.0 document for IAP", + "tags": ["help"], + "parameters": [ + { + "name": "url", + "in": "query", + "description": "url", + "required": false, + "schema": { + "type": "string", + "examples": ["http://localhost:3000"] + } + } + ], + "operationId": "Help.getOpenApi", + "responses": { + "200": { + "description": "An OpenAPI v3 document containing all IAP routes", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/indexes": { + "get": { + "summary": "Get all pre-defined indexes.", + "description": "Get all pre-defined indexes to be used in Mongo.", + "tags": ["indexes"], + "parameters": [ + { + "name": "application", + "in": "query", + "description": "application", + "required": false, + "schema": { + "type": "string", + "examples": ["@itential/app-workflow_engine"] + } + } + ], + "operationId": "Indexes.getIndexes", + "responses": { + "200": { + "description": "Contains an array of pre-defined Mongo indexes.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Indexes.admin", "Indexes.apiread"], + "CookieAuth": ["Indexes.admin", "Indexes.apiread"], + "BasicAuth": ["Indexes.admin", "Indexes.apiread"] + } + ], + "deprecated": false + } + }, + "/indexes/{collection}/status": { + "get": { + "summary": "Check the status of a collection's indexes in Mongo", + "description": "Check the status of pre-defined indexes for a specific collection.", + "tags": ["indexes"], + "parameters": [ + { + "name": "collection", + "in": "path", + "description": "The name of a collection in Mongo.", + "required": true, + "schema": { + "type": "string", + "title": "collection", + "description": "The collection name in the database." + } + } + ], + "operationId": "Indexes.checkIndexes", + "responses": { + "200": { + "description": "The current statuses of the indexes on the specified collection.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "missing": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "misnamed": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "external": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "indexed": { + "type": "integer", + "minimum": 0 + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + }, + "collectionSize": { + "type": "integer" + }, + "inProgress": { + "type": "boolean" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Indexes.admin", "Indexes.apiread"], + "CookieAuth": ["Indexes.admin", "Indexes.apiread"], + "BasicAuth": ["Indexes.admin", "Indexes.apiread"] + } + ], + "deprecated": false + } + }, + "/indexes/status": { + "get": { + "summary": "Check the status of multiple collections' indexes in Mongo", + "description": "Check the status of pre-defined indexes for multiple collections.", + "tags": ["indexes"], + "parameters": [ + { + "name": "collections", + "in": "query", + "description": "collections", + "required": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["accounts", "automations"]] + }, + { + "type": "string", + "examples": ["accounts"] + } + ] + } + } + ], + "operationId": "Indexes.checkMultipleIndexes", + "responses": { + "200": { + "description": "The current statuses of the indexes on the specified collections.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": {}, + "additionalProperties": { + "title": "result", + "type": "object", + "properties": { + "missing": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "misnamed": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "indexed": { + "type": "integer", + "minimum": 0 + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + }, + "collectionSize": { + "type": "integer" + }, + "inProgress": { + "type": "boolean" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Indexes.admin", "Indexes.apiread"], + "CookieAuth": ["Indexes.admin", "Indexes.apiread"], + "BasicAuth": ["Indexes.admin", "Indexes.apiread"] + } + ], + "deprecated": false + } + }, + "/indexes/{collection}": { + "post": { + "summary": "Create a collection's indexes in Mongo", + "description": "Create all pre-defined indexes for a specific collection.", + "tags": ["indexes"], + "parameters": [ + { + "name": "collection", + "in": "path", + "description": "The name of a collection in Mongo.", + "required": true, + "schema": { + "type": "string", + "title": "collection", + "description": "The collection name in the database." + } + } + ], + "operationId": "Indexes.createIndexes", + "responses": { + "200": { + "description": "The current status of the index creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "unchanged": { + "type": "integer", + "minimum": 0 + }, + "changed": { + "type": "integer", + "minimum": 0 + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + }, + "running": { + "type": "boolean" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Indexes.admin"], + "CookieAuth": ["Indexes.admin"], + "BasicAuth": ["Indexes.admin"] + } + ], + "deprecated": false + } + }, + "/authorization/accounts": { + "get": { + "summary": "Get all accounts.", + "description": "Get all accounts", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_accounts-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_accounts-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_accounts-query" + } + }, + { + "name": "inactive", + "in": "query", + "description": "inactive", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema_inactive" + } + }, + { + "name": "isServiceAccount", + "in": "query", + "description": "isServiceAccount", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema_isServiceAccount" + } + }, + { + "name": "groupId", + "in": "query", + "description": "groupId", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "loggedIn", + "in": "query", + "description": "loggedIn", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema_loggedIn" + } + } + ], + "operationId": "Authorization.getAccounts", + "responses": { + "200": { + "description": "The accounts matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_accounts-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + } + }, + "/authorization/accounts/{accountId}": { + "get": { + "summary": "Get an individual account.", + "description": "Get an individual account", + "tags": ["authorization"], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The id for the requested account.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.getAccount", + "responses": { + "200": { + "description": "The individual account document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update an account.", + "description": "Update an account", + "tags": ["authorization"], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The individual account to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.updateAccount", + "responses": { + "200": { + "description": "The output of the account update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "inactive": { + "$ref": "#/components/schemas/iap_accounts-schema_inactive" + }, + "email": { + "$ref": "#/components/schemas/iap_accounts-schema_email" + }, + "assignedRoles": { + "$ref": "#/components/schemas/iap_accounts-schema_assignedRoles" + }, + "memberOf": { + "$ref": "#/components/schemas/iap_accounts-schema_memberOf" + } + } + } + } + } + } + } + } + } + }, + "/authorization/accounts/{accountId}/forceLogout": { + "post": { + "summary": "Force a user to logout and remove their session.", + "description": "Force a user to logout", + "tags": ["authorization"], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The individual account to logout.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.forceLogout", + "responses": { + "200": { + "description": "The output of removing a session", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false + } + }, + "/authorization/groups": { + "get": { + "summary": "Get a list of groups.", + "description": "Get a list of groups", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "inactive", + "in": "query", + "description": "inactive", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_groups-schema_inactive" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "refresh", + "in": "query", + "description": "whether to refresh groups from AAA", + "required": false, + "schema": { + "type": "boolean", + "title": "refresh", + "description": "whether to refresh groups from AAA", + "default": false + } + } + ], + "operationId": "Authorization.getGroups", + "responses": { + "200": { + "description": "The groups matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_groups-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Create a group.", + "description": "Create a group", + "tags": ["authorization"], + "parameters": [], + "operationId": "Authorization.createGroup", + "responses": { + "200": { + "description": "Result of group creation process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_groups-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "$ref": "#/components/schemas/iap_groups-schema" + } + } + } + } + } + } + } + }, + "/authorization/groups/list": { + "get": { + "summary": "Get a simplified list of groups.", + "description": "Get a simplified list of groups", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "inactive", + "in": "query", + "description": "inactive", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_groups-schema_inactive" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "refresh", + "in": "query", + "description": "whether to refresh groups from AAA", + "required": false, + "schema": { + "type": "boolean", + "title": "refresh", + "description": "whether to refresh groups from AAA", + "default": false + } + } + ], + "operationId": "Authorization.getGroupsShortList", + "responses": { + "200": { + "description": "The groups matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "$ref": "#/components/schemas/iap_groups-schema_provenance" + }, + "name": { + "$ref": "#/components/schemas/iap_groups-schema_name" + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/authorization/groups/{groupId}": { + "get": { + "summary": "Get an individual group.", + "description": "Get an individual group", + "tags": ["authorization"], + "parameters": [ + { + "name": "groupId", + "in": "path", + "description": "The id for the requested group.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.getGroup", + "responses": { + "200": { + "description": "The individual group document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_groups-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update a group.", + "description": "Update a group", + "tags": ["authorization"], + "parameters": [ + { + "name": "groupId", + "in": "path", + "description": "The individual group to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.updateGroup", + "responses": { + "200": { + "description": "The output of the group update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_groups-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/iap_groups-schema_description" + }, + "inactive": { + "$ref": "#/components/schemas/iap_groups-schema_inactive" + }, + "memberOf": { + "$ref": "#/components/schemas/iap_groups-schema_memberOf" + }, + "assignedRoles": { + "$ref": "#/components/schemas/iap_groups-schema_assignedRoles" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a group.", + "description": "Delete a group", + "tags": ["authorization"], + "parameters": [ + { + "name": "groupId", + "in": "path", + "description": "The individual group to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.deleteGroup", + "responses": { + "200": { + "description": "Result of group deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false + } + }, + "/authorization/roles": { + "get": { + "summary": "Get a list of roles.", + "description": "Get a list of roles", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roles-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roles-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roles-query" + } + }, + { + "name": "inactive", + "in": "query", + "description": "inactive", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Authorization.getRoles", + "responses": { + "200": { + "description": "The roles matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_roles-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Create a role.", + "description": "Create a role", + "tags": ["authorization"], + "parameters": [], + "operationId": "Authorization.createRole", + "responses": { + "200": { + "description": "Result of role creation process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_roles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "$ref": "#/components/schemas/iap_roles-schema" + } + } + } + } + } + } + } + }, + "/authorization/roles/{roleId}": { + "get": { + "summary": "Get an individual role.", + "description": "Get an individual role", + "tags": ["authorization"], + "parameters": [ + { + "name": "roleId", + "in": "path", + "description": "The id for the requested role.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roleId" + } + } + ], + "operationId": "Authorization.getRole", + "responses": { + "200": { + "description": "The individual role document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_roles-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update a role.", + "description": "Update a role", + "tags": ["authorization"], + "parameters": [ + { + "name": "roleId", + "in": "path", + "description": "The individual role to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roleId" + } + } + ], + "operationId": "Authorization.updateRole", + "responses": { + "200": { + "description": "The output of the role update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_roles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/iap_roles-schema_description" + }, + "allowedMethods": { + "$ref": "#/components/schemas/iap_roles-schema_allowedMethods" + }, + "allowedViews": { + "$ref": "#/components/schemas/iap_roles-schema_allowedViews" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a role.", + "description": "Delete a role", + "tags": ["authorization"], + "parameters": [ + { + "name": "roleId", + "in": "path", + "description": "The individual role to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roleId" + } + } + ], + "operationId": "Authorization.deleteRole", + "responses": { + "200": { + "description": "Result of role deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false + } + }, + "/authorization/methods": { + "get": { + "summary": "Get a list of methods.", + "description": "Get a list of methods in IAP.", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_methods-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_methods-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_methods-query" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Authorization.getMethods", + "responses": { + "200": { + "description": "List of methods in IAP.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["getRoles"] + }, + "provenance": { + "type": "string", + "examples": ["Authorization"] + }, + "route": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/roles"] + }, + "verb": { + "type": "string", + "examples": ["GET"] + }, + "fullPath": { + "type": "string", + "examples": ["/authorization/roles"] + } + } + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + } + }, + "/authorization/views": { + "get": { + "summary": "Get a list of views.", + "description": "Get a list of views in IAP.", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_views-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_views-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_views-query" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Authorization.getViews", + "responses": { + "200": { + "description": "List of views in IAP.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/"] + }, + "provenance": { + "type": "string", + "examples": ["WorkFlowEngine"] + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + } + }, + "/authorization/csv/export": { + "get": { + "summary": "Extract CSV data of accounts, groups, and roles", + "description": "Retrieve CSV data of accounts, groups, and roles information", + "tags": ["authorization"], + "parameters": [], + "operationId": "Authorization.exportAuthReport", + "responses": { + "200": { + "description": "Result of export", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + } + }, + "/device-counts": { + "get": { + "summary": "Get device count history", + "description": "Get device count history", + "tags": ["device-counts"], + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "type": "string", + "enum": ["newest", "oldest"], + "default": "newest" + } + }, + { + "name": "serverId", + "in": "query", + "description": "The server ID where the device counts came from", + "required": false, + "schema": { + "type": "string", + "description": "The server ID where the device counts came from" + } + }, + { + "name": "before", + "in": "query", + "description": "The timestamp in milliseconds used as an upper range. Should be higher than the after value.", + "required": false, + "schema": { + "type": "integer", + "description": "The timestamp in milliseconds used as an upper range. Should be higher than the after value." + } + }, + { + "name": "after", + "in": "query", + "description": "The timestamp in milliseconds used as a lower range. Should be lower than the after value.", + "required": false, + "schema": { + "type": "integer", + "description": "The timestamp in milliseconds used as a lower range. Should be lower than the after value." + } + } + ], + "operationId": "DeviceCounts.getDeviceCounts", + "responses": { + "200": { + "description": "The device counts matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_device-count-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["DeviceCounts.admin"], + "CookieAuth": ["DeviceCounts.admin"], + "BasicAuth": ["DeviceCounts.admin"] + } + ], + "deprecated": false + } + }, + "/device-counts/refresh": { + "post": { + "summary": "Refresh device count history", + "description": "Refresh device count history", + "tags": ["device-counts"], + "parameters": [], + "operationId": "DeviceCounts.createDeviceCount", + "responses": { + "200": { + "description": "Refresh device count history", + "content": { + "application/json": { + "schema": {} + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["DeviceCounts.admin"], + "CookieAuth": ["DeviceCounts.admin"], + "BasicAuth": ["DeviceCounts.admin"] + } + ], + "deprecated": false + } + }, + "/health/adapters/{name}": { + "get": { + "summary": "Get the health of a single adapter.", + "description": "Get the health of a single adapter in IAP.", + "tags": ["health"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Health.getAdapterHealth", + "responses": { + "200": { + "description": "Contains the selected adapters health data.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_services-health-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/applications/{name}": { + "get": { + "summary": "Get the health of a single application.", + "description": "Get the health of a single application in IAP.", + "tags": ["health"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Health.getApplicationHealth", + "responses": { + "200": { + "description": "Contains the selected applications health data.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_services-health-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/adapters": { + "get": { + "summary": "Get the health of all the adapters.", + "description": "Get the health of all the adapters in IAP.", + "tags": ["health"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Health.getAdaptersHealth", + "responses": { + "200": { + "description": "Contains the adapters health data.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_services-health-schema" + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/applications": { + "get": { + "summary": "Get the health of all the applications.", + "description": "Get the health of all the applications in IAP.", + "tags": ["health"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Health.getApplicationsHealth", + "responses": { + "200": { + "description": "Contains the applications health data.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_services-health-schema" + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/server": { + "get": { + "summary": "Get the health of the server.", + "description": "Get the health of the server.", + "tags": ["health"], + "parameters": [], + "operationId": "Health.getServerHealth", + "responses": { + "200": { + "description": "Contains the server health data.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "release": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "arch": { + "type": "string", + "enum": [ + "arm", + "arm64", + "ia32", + "mips", + "mipsel", + "ppc", + "ppc64", + "s390", + "s390x", + "x32", + "x64" + ] + }, + "platform": { + "type": "string", + "enum": [ + "aix", + "darwin", + "freebsd", + "linux", + "openbsd", + "sunos", + "win32" + ] + }, + "versions": { + "type": "object", + "properties": { + "node": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "v8": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "uv": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "zlib": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "brotli": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "ares": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "modules": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "nghttp2": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "napi": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "llhttp": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "http_parser": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "openssl": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "cldr": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "icu": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "tz": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "unicode": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + } + } + }, + "memoryUsage": { + "$ref": "#/components/schemas/iap_services-health-schema_memoryUsage" + }, + "cpuUsage": { + "$ref": "#/components/schemas/iap_services-health-schema_cpuUsage" + }, + "uptime": { + "$ref": "#/components/schemas/iap_services-health-schema_uptime" + }, + "pid": { + "$ref": "#/components/schemas/iap_services-health-schema_pid" + }, + "dependencies": { + "type": "object", + "properties": { + "@itential/logger": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "@itential/database": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "@itential/itential-utils": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/system": { + "get": { + "summary": "Get the health of the system.", + "description": "Get the health of the system.", + "tags": ["health"], + "parameters": [], + "operationId": "Health.getSystemHealth", + "responses": { + "200": { + "description": "Contains the system health data.", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "results", + "properties": { + "arch": { + "type": "string", + "examples": ["x64"] + }, + "release": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "uptime": { + "type": "integer", + "examples": [12539] + }, + "freemem": { + "type": "integer", + "examples": [14377422848] + }, + "totalmem": { + "type": "integer", + "examples": [34359738368] + }, + "loadavg": { + "type": "array", + "items": { + "type": "number", + "examples": [3.0166015625, 1.74169921875] + } + }, + "cpus": { + "type": "array", + "items": { + "type": "object", + "required": ["model", "speed", "times"], + "properties": { + "model": { + "type": "string", + "examples": [ + "Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz" + ] + }, + "speed": { + "type": "integer", + "examples": [2300] + }, + "times": { + "type": "object", + "required": ["user", "nice", "sys", "idle", "irq"], + "properties": { + "user": { + "type": "integer", + "examples": [604790] + }, + "nice": { + "type": "integer", + "examples": [0] + }, + "sys": { + "type": "integer", + "examples": [322560] + }, + "idle": { + "type": "integer", + "examples": [6071010] + }, + "irq": { + "type": "integer", + "examples": [0] + } + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/status": { + "get": { + "summary": "Get status.", + "description": "Get status of current IAP.", + "tags": ["health"], + "parameters": [], + "operationId": "Health.getHealthStatus", + "responses": { + "200": { + "description": "status of the current IAP.", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "serverId": { + "type": "string" + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "service": { + "type": "string" + }, + "status": { + "type": "string", + "enum": ["running", "failed"] + } + } + } + }, + "timestamp": { + "type": "integer" + }, + "apps": { + "type": "string", + "enum": ["running", "degraded"] + }, + "adapters": { + "type": "string", + "enum": ["running", "degraded"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/prebuilts/{id}/export": { + "get": { + "summary": "Export a prebuilt", + "description": "Export a prebuilt from IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The object id of the selected prebuilt.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Prebuilts.exportPrebuilt", + "responses": { + "200": { + "description": "The data for a prebuilt.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] + } + ], + "deprecated": false + } + }, + "/prebuilts/{id}": { + "get": { + "summary": "Get a single prebuilt.", + "description": "Get a single prebuilt in IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The object id of the selected prebuilt.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Prebuilts.getPrebuilt", + "responses": { + "200": { + "description": "The data for a prebuilt.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Remove a prebuilt.", + "description": "Remove a prebuilt from IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The object id of the selected prebuilt.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Prebuilts.removePrebuilt", + "responses": { + "200": { + "description": "The output of the prebuilt removal process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Prebuilts.admin"], + "CookieAuth": ["Prebuilts.admin"], + "BasicAuth": ["Prebuilts.admin"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update a prebuilt", + "description": "Update a prebuilt in IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The object id of the selected prebuilt.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Prebuilts.updatePrebuilt", + "responses": { + "200": { + "description": "The output of the prebuilt update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Prebuilts.admin"], + "CookieAuth": ["Prebuilts.admin"], + "BasicAuth": ["Prebuilts.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prebuilt": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + } + } + } + } + }, + "/prebuilts": { + "get": { + "summary": "Get all the prebuilts.", + "description": "Get all the prebuilts in IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["nso"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["artifact-wizard"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["n", "a"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "config", + "in": "query", + "description": "config", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_config" + } + } + ], + "operationId": "Prebuilts.getPrebuilts", + "responses": { + "200": { + "description": "Contains an array of prebuilts and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "required": ["packages", "total"], + "properties": { + "packages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] + } + ], + "deprecated": false + } + }, + "/prebuilts/import": { + "post": { + "summary": "Import a prebuilt.", + "description": "Import a prebuilt into IAP.", + "tags": ["prebuilts"], + "parameters": [], + "operationId": "Prebuilts.importPrebuilt", + "responses": { + "200": { + "description": "The output of the prebuilt import process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Prebuilts.admin"], + "CookieAuth": ["Prebuilts.admin"], + "BasicAuth": ["Prebuilts.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prebuilt": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "overwrite": { + "type": "boolean", + "description": "If the import functionality should overwrite existing components", + "examples": [true, false] + } + } + } + } + } + } + } + } + } + }, + "/prebuilts/import/validation": { + "put": { + "summary": "Validate the data structure of a prebuilt.", + "description": "Validate the data structure of a prebuilt in IAP.", + "tags": ["prebuilts"], + "parameters": [], + "operationId": "Prebuilts.validatePrebuilt", + "responses": { + "200": { + "description": "The output of the prebuilt update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Prebuilts.admin"], + "CookieAuth": ["Prebuilts.admin"], + "BasicAuth": ["Prebuilts.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prebuilt": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + } + } + } + } + }, + "/external-links": { + "get": { + "summary": "Get all links.", + "description": "Get all links", + "tags": ["external-links"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_links-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_links-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_links-query" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "ExternalLinks.getLinks", + "responses": { + "200": { + "description": "The links matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_links-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], + "CookieAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], + "BasicAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Update a link.", + "description": "Create a link", + "tags": ["external-links"], + "parameters": [], + "operationId": "ExternalLinks.createLink", + "responses": { + "200": { + "description": "Result of link creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_links-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["ExternalLinks.admin"], + "CookieAuth": ["ExternalLinks.admin"], + "BasicAuth": ["ExternalLinks.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "link": { + "$ref": "#/components/schemas/iap_links-schema" + } + } + } + } + } + } + } + }, + "/external-links/{linkId}": { + "get": { + "summary": "Get an individual link.", + "description": "Get an individual link", + "tags": ["external-links"], + "parameters": [ + { + "name": "linkId", + "in": "path", + "description": "The id for the requested link.", + "required": true, + "schema": { + "title": "linkId", + "type": "string" + } + } + ], + "operationId": "ExternalLinks.getLink", + "responses": { + "200": { + "description": "The individual link document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_links-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], + "CookieAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], + "BasicAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update a link.", + "description": "Update a link", + "tags": ["external-links"], + "parameters": [ + { + "name": "linkId", + "in": "path", + "description": "The individual link to update.", + "required": true, + "schema": { + "title": "linkId", + "type": "string" + } + } + ], + "operationId": "ExternalLinks.updateLink", + "responses": { + "200": { + "description": "The output of the link update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_links-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["ExternalLinks.admin"], + "CookieAuth": ["ExternalLinks.admin"], + "BasicAuth": ["ExternalLinks.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_links-schema_name" + }, + "address": { + "$ref": "#/components/schemas/iap_links-schema_address" + }, + "description": { + "$ref": "#/components/schemas/iap_links-schema_description" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a link.", + "description": "Delete a link", + "tags": ["external-links"], + "parameters": [ + { + "name": "linkId", + "in": "path", + "description": "The individual link to delete.", + "required": true, + "schema": { + "title": "linkId", + "type": "string" + } + } + ], + "operationId": "ExternalLinks.deleteLink", + "responses": { + "200": { + "description": "Result of link deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["ExternalLinks.admin"], + "CookieAuth": ["ExternalLinks.admin"], + "BasicAuth": ["ExternalLinks.admin"] + } + ], + "deprecated": false + } + }, + "/prebuilts-repository/configs": { + "post": { + "summary": "Create repository configuration", + "description": "Create a new repository configuration", + "tags": ["prebuilts-repository"], + "parameters": [], + "operationId": "PrebuiltsRepository.createRepositoryConfig", + "responses": { + "200": { + "description": "The result of the creation process", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_repository-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "config": { + "$ref": "#/components/schemas/iap_repository-schema" + } + } + } + } + } + } + }, + "get": { + "summary": "Get Repository Configurations", + "description": "Get all the Prebuilt Repository configurations", + "tags": ["prebuilts-repository"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "PrebuiltsRepository.getRepositoryConfigs", + "responses": { + "200": { + "description": "Contains an array of prebuilts and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "required": ["results", "total"], + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_prebuilts-schema_name" + }, + "enabled": { + "$ref": "#/components/schemas/iap_repository-schema_enabled" + }, + "type": { + "$ref": "#/components/schemas/iap_repository-schema_type" + }, + "hostname": { + "$ref": "#/components/schemas/iap_repository-schema_hostname" + }, + "path": { + "$ref": "#/components/schemas/iap_repository-schema_path" + }, + "credentials": { + "$ref": "#/components/schemas/iap_repository-schema_credentials" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false + } + }, + "/prebuilts-repository/configs/{name}": { + "delete": { + "summary": "Delete repository configuration", + "description": "Delete an existing repository configuration", + "tags": ["prebuilts-repository"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the repository configuration", + "required": true, + "schema": { + "title": "name", + "type": "string" + } + } + ], + "operationId": "PrebuiltsRepository.deleteRepositoryConfig", + "responses": { + "200": { + "description": "The result of the delete process", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update repository configuration", + "description": "Update an existing repository configuration", + "tags": ["prebuilts-repository"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the repository configuration", + "required": true, + "schema": { + "title": "name", + "type": "string" + } + } + ], + "operationId": "PrebuiltsRepository.updateRepositoryConfig", + "responses": { + "200": { + "description": "The result of the update process", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_repository-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "A flag that denotes if the repository configuration is connected" + }, + "type": { + "type": "string", + "description": "The type of Repository", + "enum": ["gitlab"] + }, + "hostname": { + "type": "string", + "description": "The hostname of the Respository endpoint", + "examples": ["gitlab.com"] + }, + "path": { + "type": "string", + "description": "The path of the Repository endpoint", + "examples": ["itentialopensource/pre-built-automations"] + }, + "credentials": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "An access token used to make HTTP requests", + "examples": ["uTc_P4pnMAEsLbQHmyOt"] + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + } + } + }, + "/prebuilts-repository": { + "get": { + "summary": "Get all prebuilts", + "description": "Get all prebuilts from a repository.", + "tags": ["prebuilts-repository"], + "parameters": [ + { + "name": "page", + "in": "query", + "description": "The page number for the request return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "The page number for the request return. Used for pagination.", + "default": 1, + "minimum": 1, + "examples": [1, 3, 5] + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "iap_version", + "in": "query", + "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.", + "required": false, + "schema": { + "type": "number", + "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.", + "examples": [2019.3, 2020.1] + } + }, + { + "name": "search", + "in": "query", + "description": "Search all available artifacts to find a match related to the provided query.", + "required": false, + "schema": { + "type": "string", + "description": "Search all available artifacts to find a match related to the provided query.", + "examples": ["device", "nso"] + } + }, + { + "name": "config", + "in": "query", + "description": "config", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_config" + } + }, + { + "name": "versionStatus", + "in": "query", + "description": "Filter the list of Pre-builts based on the available version of the Pre-built in comparison to the current version of IAP", + "required": false, + "schema": { + "type": "string", + "description": "Filter the list of Pre-builts based on the available version of the Pre-built in comparison to the current version of IAP", + "enum": ["latest", "current"] + } + } + ], + "operationId": "PrebuiltsRepository.getRepositoryPrebuilts", + "responses": { + "200": { + "description": "Contains an array of prebuilts and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "required": ["results", "total"], + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "versionStatus": { + "type": "object", + "properties": { + "status": { + "type": "string", + "examples": ["current"] + }, + "iap_version": { + "type": "string", + "examples": ["release/2020.1"] + } + } + }, + "installStatus": { + "type": "object", + "properties": { + "installable": { + "type": "boolean", + "enum": [true, false] + }, + "missingDependencies": { + "oneOf": [ + { + "type": "object", + "description": "A list of every dependency in the prebuilt that is missing from the running system." + }, + { + "type": "null" + } + ] + }, + "mismatchingDependencies": { + "oneOf": [ + { + "type": "object", + "description": "A list of every dependency in the prebuilt that has a version greater than the version of the service running on the system." + }, + { + "type": "null" + } + ] + } + } + }, + "availableUpdate": { + "oneOf": [ + { + "type": "boolean", + "enum": [true, false] + }, + { + "type": "null" + } + ] + }, + "name": { + "$ref": "#/components/schemas/iap_prebuilts-schema_name" + }, + "version": { + "$ref": "#/components/schemas/iap_prebuilts-schema_version" + }, + "description": { + "$ref": "#/components/schemas/iap_prebuilts-schema_description" + }, + "author": { + "$ref": "#/components/schemas/iap_prebuilts-schema_author" + }, + "published": { + "type": "string", + "examples": ["2020-04-09T17:44:30.215Z"], + "format": "date-time" + }, + "repository": { + "$ref": "#/components/schemas/iap_prebuilts-schema_repository" + }, + "license": { + "$ref": "#/components/schemas/iap_prebuilts-schema_license" + }, + "keywords": { + "$ref": "#/components/schemas/iap_prebuilts-schema_keywords" + }, + "IAPDependencies": { + "$ref": "#/components/schemas/iap_prebuilts-schema_IAPDependencies" + }, + "readme": { + "$ref": "#/components/schemas/iap_prebuilts-schema_readme" + }, + "download": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + }, + "page": { + "type": "integer" + }, + "total-pages": { + "type": "integer" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false + } + }, + "/sso/configs": { + "post": { + "summary": "Create an SSO configuration", + "description": "Create an SSO configuration", + "tags": ["sso"], + "parameters": [], + "operationId": "SSO.createSSOConfig", + "responses": { + "200": { + "description": "The result of the SSO config creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSO.admin"], + "CookieAuth": ["SSO.admin"], + "BasicAuth": ["SSO.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + } + } + } + }, + "get": { + "summary": "Get all SSO configurations", + "description": "Get all SSO configurations", + "tags": ["sso"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["GitHub"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "enum": [ + "name", + "samlEmailAttribute", + "samlUserNameAttribute", + "samlGroupsAttribute", + "samlFirstNameAttribute", + "ssoType" + ] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["Okta"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "enum": [ + "name", + "samlEmailAttribute", + "samlUserNameAttribute", + "samlGroupsAttribute", + "samlFirstNameAttribute", + "ssoType" + ] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["Okta"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "enum": [ + "name", + "samlEmailAttribute", + "samlUserNameAttribute", + "samlGroupsAttribute", + "samlFirstNameAttribute", + "ssoType" + ] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "SSO.getSSOConfigs", + "responses": { + "200": { + "description": "Contains an array of SSO configurations and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_sso-schema" + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSO.admin", "SSO.apiread"], + "CookieAuth": ["SSO.admin", "SSO.apiread"], + "BasicAuth": ["SSO.admin", "SSO.apiread"] + } + ], + "deprecated": false + } + }, + "/sso/configs/{name}": { + "delete": { + "summary": "Delete an SSO configuration", + "description": "Delete an SSO configuration", + "tags": ["sso"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration to delete", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "SSO.deleteSSOConfig", + "responses": { + "200": { + "description": "The result of the SSO config deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSO.admin"], + "CookieAuth": ["SSO.admin"], + "BasicAuth": ["SSO.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a single SSO configuration", + "description": "Get a single SSO configuration", + "tags": ["sso"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration to get", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "SSO.getSSOConfig", + "responses": { + "200": { + "description": "The SSO configuration document", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSO.admin", "SSO.apiread"], + "CookieAuth": ["SSO.admin", "SSO.apiread"], + "BasicAuth": ["SSO.admin", "SSO.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an SSO configuration", + "description": "Update an SSO configuration", + "tags": ["sso"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration to delete", + "required": true, + "schema": { + "title": "result", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "SSO.updateSSOConfig", + "responses": { + "200": { + "description": "The result of the SSO config update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSO.admin"], + "CookieAuth": ["SSO.admin"], + "BasicAuth": ["SSO.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + } + } + } + } + }, + "/sso/configs/{name}/active": { + "post": { + "summary": "Activate an SSO configuration", + "description": "Activate an SSO configuration", + "tags": ["sso"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration to delete", + "required": true, + "schema": { + "title": "result", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "SSO.setSSOConfigActive", + "responses": { + "200": { + "description": "The result of the SSO config update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSO.admin"], + "CookieAuth": ["SSO.admin"], + "BasicAuth": ["SSO.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "active": { + "title": "active", + "type": "boolean" + } + } + } + } + } + } + } + }, + "/prometheus_metrics": { + "get": { + "summary": "Get prometheus metrics.", + "description": "Builds and returns all prometheus metrics.", + "tags": ["prometheus_metrics"], + "parameters": [], + "operationId": "PrometheusMetrics.getPrometheusMetrics", + "responses": { + "200": { + "description": "result", + "content": { + "application/json": { + "schema": { + "title": "result", + "description": "Metrics to be ingested by prometheus.", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/group-mappings": { + "get": { + "summary": "Get all group mappings.", + "description": "Get all group mappings", + "tags": ["group-mappings"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "expand", + "in": "query", + "description": "Sets the fields to expand", + "required": false, + "schema": { + "type": "string", + "title": "List of fields to get expanded data", + "description": "Sets the fields to expand", + "examples": ["iapGroups"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "SSOGroupMappings.getGroupMappings", + "responses": { + "200": { + "description": "The group mappings matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_mapping-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"], + "CookieAuth": [ + "SSOGroupMappings.admin", + "SSOGroupMappings.apiread" + ], + "BasicAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Create a group mapping.", + "description": "Create a group mapping", + "tags": ["group-mappings"], + "parameters": [], + "operationId": "SSOGroupMappings.createGroupMapping", + "responses": { + "200": { + "description": "Result of group mapping creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_mapping-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSOGroupMappings.admin"], + "CookieAuth": ["SSOGroupMappings.admin"], + "BasicAuth": ["SSOGroupMappings.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupMapping": { + "$ref": "#/components/schemas/iap_mapping-schema" + } + } + } + } + } + } + } + }, + "/group-mappings/{provenance}/{externalGroup}": { + "get": { + "summary": "Get an individual group mapping.", + "description": "Get an individual group mapping", + "tags": ["group-mappings"], + "parameters": [ + { + "name": "provenance", + "in": "path", + "description": "The provenance for the requested group mapping.", + "required": true, + "schema": { + "title": "provenance", + "type": "string" + } + }, + { + "name": "externalGroup", + "in": "path", + "description": "The name of the external group that is mapped.", + "required": true, + "schema": { + "title": "externalGroup", + "type": "string" + } + } + ], + "operationId": "SSOGroupMappings.getGroupMapping", + "responses": { + "200": { + "description": "The individual group mapping document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_mapping-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"], + "CookieAuth": [ + "SSOGroupMappings.admin", + "SSOGroupMappings.apiread" + ], + "BasicAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update a group mapping.", + "description": "Update a group mapping", + "tags": ["group-mappings"], + "parameters": [ + { + "name": "provenance", + "in": "path", + "description": "The provenance for the requested group mapping.", + "required": true, + "schema": { + "title": "provenance", + "type": "string" + } + }, + { + "name": "externalGroup", + "in": "path", + "description": "The individual group mapping to update.", + "required": true, + "schema": { + "title": "externalGroup", + "type": "string" + } + } + ], + "operationId": "SSOGroupMappings.updateGroupMapping", + "responses": { + "200": { + "description": "The output of the group mapping update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_mapping-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSOGroupMappings.admin"], + "CookieAuth": ["SSOGroupMappings.admin"], + "BasicAuth": ["SSOGroupMappings.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "iapGroups": { + "$ref": "#/components/schemas/iap_mapping-schema_iapGroups" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a group mapping.", + "description": "Delete a group mapping", + "tags": ["group-mappings"], + "parameters": [ + { + "name": "provenance", + "in": "path", + "description": "The provenance for the requested group mapping.", + "required": true, + "schema": { + "title": "provenance", + "type": "string" + } + }, + { + "name": "externalGroup", + "in": "path", + "description": "The individual group mapping to delete.", + "required": true, + "schema": { + "title": "externalGroup", + "type": "string" + } + } + ], + "operationId": "SSOGroupMappings.deleteGroupMapping", + "responses": { + "200": { + "description": "Result of group mapping deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["SSOGroupMappings.admin"], + "CookieAuth": ["SSOGroupMappings.admin"], + "BasicAuth": ["SSOGroupMappings.admin"] + } + ], + "deprecated": false + } + }, + "/git/{gitType}/repos/{repoPath}/branches/{branchName}/projects/{projectPath}": { + "get": { + "summary": "Retrieve a project from Git", + "description": "Retrieve a project from Git", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + }, + { + "name": "branchName", + "in": "path", + "description": "The name of the branch that is used.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_branchName" + } + }, + { + "name": "projectPath", + "in": "path", + "description": "The file path within a Git repository to a project file", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_projectPath" + } + } + ], + "operationId": "Git.getProject", + "responses": { + "200": { + "description": "The exact contents of the project file stored in Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + }, + "post": { + "summary": "Initialize a project in Git", + "description": "Initialize a project in Git", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + }, + { + "name": "branchName", + "in": "path", + "description": "The name of the branch that is used.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_branchName" + } + }, + { + "name": "projectPath", + "in": "path", + "description": "The file path within a Git repository to a project file", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_projectPath" + } + }, + { + "name": "project", + "in": "path", + "description": "The project document being pushed to Git", + "required": true, + "schema": { + "title": "project", + "type": "object" + } + } + ], + "operationId": "Git.initProject", + "responses": { + "200": { + "description": "The result of initializing a project in Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully initialized project"] + }, + "data": { + "type": "object", + "description": "The project document pushed to Git" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commitMessage": { + "$ref": "#/components/schemas/iap_git-common_commitMessage" + } + } + } + } + } + } + }, + "put": { + "summary": "Update a project in Git", + "description": "Update a project in Git", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + }, + { + "name": "branchName", + "in": "path", + "description": "The name of the branch that is used.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_branchName" + } + }, + { + "name": "projectPath", + "in": "path", + "description": "The file path within a Git repository to a project file", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_projectPath" + } + }, + { + "name": "project", + "in": "path", + "description": "The project document being pushed to Git", + "required": true, + "schema": { + "title": "project", + "type": "object" + } + } + ], + "operationId": "Git.updateProject", + "responses": { + "200": { + "description": "The result of updating a project in Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully updated project"] + }, + "data": { + "type": "object", + "description": "The project document pushed to Git" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commitMessage": { + "$ref": "#/components/schemas/iap_git-common_commitMessage" + } + } + } + } + } + } + } + }, + "/git/{gitType}/repos/{repoPath}/branches": { + "post": { + "summary": "Create a new branch in a repository", + "description": "Create a new branch in a repository", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + } + ], + "operationId": "Git.createBranch", + "responses": { + "200": { + "description": "The result of creating a branch", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully created branch: exampleBranch"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "originBranch": { + "$ref": "#/components/schemas/iap_git-common_branchName" + }, + "newBranch": { + "$ref": "#/components/schemas/iap_git-common_branchName" + } + } + } + } + } + } + }, + "get": { + "summary": "List the available branches for a repository", + "description": "List the available branches for a repository", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + } + ], + "operationId": "Git.listBranches", + "responses": { + "200": { + "description": "The result of retrieving a list of branches from Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "The name of the branch", + "type": "string", + "examples": ["main"] + }, + "protected": { + "description": "Whether or not the branch is protected", + "type": "boolean" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false + } + }, + "/git/{gitType}/repos/{repoPath}": { + "post": { + "summary": "Create a new repository in Git for storing projects", + "description": "Create a new repository in Git for storing projects", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + } + ], + "operationId": "Git.createRepo", + "responses": { + "200": { + "description": "The result of creating a repository in Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": [ + "`Successfully created repository: ExampleRepo" + ] + }, + "data": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The full path to the repository in Git", + "examples": [ + "group1/group2/ExampleRepo", + "exampleOrg/ExampleRepo" + ] + }, + "default_branch": { + "type": "string", + "description": "The default branch created for the repository", + "examples": ["main"] + }, + "visibility": { + "type": "string", + "description": "The visibility of the repository", + "examples": ["private"] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repoName": { + "title": "repoName", + "type": "string", + "examples": ["RepositoryName"] + } + } + } + } + } + } + } + }, + "/profiles": { + "post": { + "summary": "Creates a new profile", + "description": "Create a new profile in IAP.", + "tags": ["profiles"], + "parameters": [], + "operationId": "Profiles.createProfile", + "responses": { + "200": { + "description": "The output of the profile creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "uiProps": { + "$ref": "#/components/schemas/iap_profiles-schema_uiProps" + }, + "authenticationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" + }, + "expressProps": { + "$ref": "#/components/schemas/iap_profiles-schema_expressProps" + }, + "loggerProps": { + "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" + }, + "redisProps": { + "$ref": "#/components/schemas/iap_profiles-schema_redisProps" + }, + "auditProps": { + "$ref": "#/components/schemas/iap_profiles-schema_auditProps" + }, + "pathProps": { + "$ref": "#/components/schemas/iap_profiles-schema_pathProps" + }, + "alarmProps": { + "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" + }, + "id": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + }, + "services": { + "$ref": "#/components/schemas/iap_profiles-schema_services" + }, + "description": { + "$ref": "#/components/schemas/iap_profiles-schema_description" + }, + "adapterStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" + }, + "systemProps": { + "$ref": "#/components/schemas/iap_profiles-schema_systemProps" + }, + "integrationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" + }, + "retryStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" + }, + "serviceDirectory": { + "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" + } + }, + "required": ["id"] + } + } + } + } + } + } + }, + "get": { + "summary": "Get all profiles.", + "description": "Get all the profiles in IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["profile1"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["id"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["profile1"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["id"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["profile"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["id"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Profiles.getProfiles", + "responses": { + "200": { + "description": "Contains the data of a profile.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + } + }, + "profile": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Profiles.admin", "Profiles.apiread"], + "CookieAuth": ["Profiles.admin", "Profiles.apiread"], + "BasicAuth": ["Profiles.admin", "Profiles.apiread"] + } + ], + "deprecated": false + } + }, + "/profiles/import": { + "post": { + "summary": "Import a new profile", + "description": "Import a new profile in IAP.", + "tags": ["profiles"], + "parameters": [], + "operationId": "Profiles.importProfile", + "responses": { + "200": { + "description": "The output of the profile import process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "uiProps": { + "$ref": "#/components/schemas/iap_profiles-schema_uiProps" + }, + "authenticationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" + }, + "expressProps": { + "$ref": "#/components/schemas/iap_profiles-schema_expressProps" + }, + "loggerProps": { + "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" + }, + "redisProps": { + "$ref": "#/components/schemas/iap_profiles-schema_redisProps" + }, + "auditProps": { + "$ref": "#/components/schemas/iap_profiles-schema_auditProps" + }, + "pathProps": { + "$ref": "#/components/schemas/iap_profiles-schema_pathProps" + }, + "alarmProps": { + "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" + }, + "id": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + }, + "services": { + "$ref": "#/components/schemas/iap_profiles-schema_services" + }, + "description": { + "$ref": "#/components/schemas/iap_profiles-schema_description" + }, + "adapterStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" + }, + "systemProps": { + "$ref": "#/components/schemas/iap_profiles-schema_systemProps" + }, + "integrationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" + }, + "retryStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" + }, + "serviceDirectory": { + "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" + }, + "migrationVersion": { + "type": "integer", + "minimum": 0 + } + }, + "required": ["id"] + } + } + } + } + } + } + } + }, + "/profiles/{id}": { + "delete": { + "summary": "Delete a profile.", + "description": "Delete a profile from IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.deleteProfile", + "responses": { + "200": { + "description": "The output of the profile deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a single profile.", + "description": "Get a single profile in the current IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.getProfile", + "responses": { + "200": { + "description": "Contains the metadata and data of a profile.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + } + }, + "profile": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Profiles.admin", "Profiles.apiread"], + "CookieAuth": ["Profiles.admin", "Profiles.apiread"], + "BasicAuth": ["Profiles.admin", "Profiles.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates a profile.", + "description": "Update a profile in IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.updateProfile", + "responses": { + "200": { + "description": "The output of the update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "uiProps": { + "$ref": "#/components/schemas/iap_profiles-schema_uiProps" + }, + "authenticationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" + }, + "expressProps": { + "$ref": "#/components/schemas/iap_profiles-schema_expressProps" + }, + "loggerProps": { + "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" + }, + "redisProps": { + "$ref": "#/components/schemas/iap_profiles-schema_redisProps" + }, + "auditProps": { + "$ref": "#/components/schemas/iap_profiles-schema_auditProps" + }, + "pathProps": { + "$ref": "#/components/schemas/iap_profiles-schema_pathProps" + }, + "alarmProps": { + "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" + }, + "id": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + }, + "services": { + "$ref": "#/components/schemas/iap_profiles-schema_services" + }, + "description": { + "$ref": "#/components/schemas/iap_profiles-schema_description" + }, + "adapterStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" + }, + "systemProps": { + "$ref": "#/components/schemas/iap_profiles-schema_systemProps" + }, + "integrationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" + }, + "retryStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" + }, + "serviceDirectory": { + "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/profiles/{id}/export": { + "get": { + "summary": "Export a single profile.", + "description": "Exports a single profile in the current IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.exportProfile", + "responses": { + "200": { + "description": "Contains the metadata and data of a profile.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Profiles.admin", "Profiles.apiread"], + "CookieAuth": ["Profiles.admin", "Profiles.apiread"], + "BasicAuth": ["Profiles.admin", "Profiles.apiread"] + } + ], + "deprecated": false + } + }, + "/profiles/{id}/active": { + "put": { + "summary": "Switch the active profile.", + "description": "Switch the active profile in the current IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.switchActiveProfile", + "responses": { + "200": { + "description": "The output of the profile creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": true + } + }, + "/oauth/serviceAccounts": { + "post": { + "summary": "Create a service account in the database.", + "description": "Create a service account in the database.", + "tags": ["oauth"], + "parameters": [], + "operationId": "OAuth.createServiceAccount", + "responses": { + "200": { + "description": "result", + "content": { + "application/json": { + "schema": { + "title": "result", + "description": "The client credentials for a new service account", + "type": "object", + "properties": { + "client_id": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + }, + "client_secret": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "accountData": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + } + } + } + } + } + }, + "get": { + "summary": "Get service accounts from the database.", + "description": "Get service accounts from the database.", + "tags": ["oauth"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "OAuth.getServiceAccounts", + "responses": { + "200": { + "description": "The service accounts matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + }, + "client_id": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" + }, + "createdBy": { + "$ref": "#/components/schemas/iap_service-accounts-schema_modifiedByDereferenced" + }, + "updated": { + "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" + }, + "updatedBy": { + "$ref": "#/components/schemas/iap_service-accounts-schema_modifiedByDereferenced" + }, + "secretUpdated": { + "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" + } + } + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false + } + }, + "/oauth/serviceAccounts/{client_id}": { + "patch": { + "summary": "Updates a service account in the database.", + "description": "Updates a service account in the database.", + "tags": ["oauth"], + "parameters": [ + { + "name": "client_id", + "in": "path", + "description": "The clientId for the service account", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + } + } + ], + "operationId": "OAuth.updateServiceAccount", + "responses": { + "200": { + "description": "The output of the service account update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Deletes a service account in the database.", + "description": "Deletes a service account in the database.", + "tags": ["oauth"], + "parameters": [ + { + "name": "client_id", + "in": "path", + "description": "The clientId for the service account", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + } + } + ], + "operationId": "OAuth.deleteServiceAccount", + "responses": { + "200": { + "description": "Result of service account deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false + } + }, + "/oauth/serviceAccounts/{client_id}/regenerate": { + "patch": { + "summary": "Regenerates the client_secret and returns the new value", + "description": "Regenerates the client_secret and returns the new value", + "tags": ["oauth"], + "parameters": [ + { + "name": "client_id", + "in": "path", + "description": "The clientId for the service account", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + } + } + ], + "operationId": "OAuth.regenerateSecret", + "responses": { + "200": { + "description": "The new client credentials for a service account", + "content": { + "application/json": { + "schema": { + "title": "result", + "description": "The updated client credentials for an existing service account", + "type": "object", + "properties": { + "client_id": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + }, + "client_secret": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false + } + }, + "/oauth/token": { + "post": { + "summary": "Retrieve a JWT from a client's credentials", + "description": "Retrieve a JWT from a client's credentials", + "tags": ["oauth"], + "parameters": [], + "operationId": "OAuth.machineAuthentication", + "responses": { + "200": { + "description": "result", + "content": { + "application/json": { + "schema": { + "title": "result", + "description": "A result containing the JWT providing the user access to IAP for a set amount of time", + "type": "object", + "properties": { + "access_token": { + "description": "The JWT providing the user access to IAP", + "type": "string" + }, + "token_type": { + "description": "The type of token provided", + "type": "string", + "enum": ["bearer"] + }, + "expires_in": { + "description": "The amount of time until the JWT expires", + "type": "integer", + "enum": [3600] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "properties": { + "client_id": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + }, + "client_secret": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" + }, + "grant_type": { + "type": "string", + "enum": ["client_credentials"] + } + } + } + } + } + } + } + }, + "/transformations/": { + "get": { + "summary": "Search for transformation documents.", + "description": "Search for transformation documents.", + "tags": ["transformations"], + "parameters": [ + { + "name": "incoming", + "in": "query", + "description": "incoming", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "outgoing", + "in": "query", + "description": "outgoing", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "schema", + "in": "query", + "description": "schema", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "not", + "in": "query", + "description": "not", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "expand", + "in": "query", + "description": "expand", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "type": "number" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "type": "number" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "type": "number" + } + }, + { + "name": "exclude-project-members", + "in": "query", + "description": "exclude-project-members", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "operationId": "Jst.searchTransformations", + "responses": { + "200": { + "description": "Transformation documents.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Creates a single transformation.", + "description": "Creates a single transformation.", + "tags": ["transformations"], + "parameters": [], + "operationId": "Jst.createTransformation", + "responses": { + "200": { + "description": "Created transformation document.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "transformation", + "content": { + "application/json": { + "schema": { + "title": "transformation", + "type": "object" + } + } + } + } + } + }, + "/transformations/import": { + "post": { + "summary": "Imports a single transformation.", + "description": "Imports a single transformation.", + "tags": ["transformations"], + "parameters": [], + "operationId": "Jst.importTransformation", + "responses": { + "200": { + "description": "Imported transformation document.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "transformation", + "content": { + "application/json": { + "schema": { + "title": "transformation", + "type": "object" + } + } + } + } + } + }, + "/transformations/{id}": { + "get": { + "summary": "Gets transformation document by id.", + "description": "Gets transformation document by id.", + "tags": ["transformations"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "Jst.getTransformation", + "responses": { + "200": { + "description": "Transformation document.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates a single transformation.", + "description": "Updates a single transformation.", + "tags": ["transformations"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "Jst.updateTransformation", + "responses": { + "200": { + "description": "Updated transformation document.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "transformation", + "content": { + "application/json": { + "schema": { + "title": "transformation", + "type": "object" + } + } + } + } + }, + "delete": { + "summary": "Deletes a single transformation document.", + "description": "Deletes a single transformation document.", + "tags": ["transformations"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "Jst.deleteTransformation", + "responses": { + "200": { + "description": "Deletion result.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Runs a transformation.", + "description": "Runs a transformation.", + "tags": ["transformations"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "Jst.runTransformation", + "responses": { + "200": { + "description": "Transformation run result.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "incoming": { + "title": "incoming", + "type": "object" + }, + "options": { + "title": "options", + "type": "object" + } + } + } + } + } + } + } + }, + "/formbuilder/saveForm": { + "post": { + "summary": "Save a Generated Form", + "description": "Save a generated form with its data.", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.saveForm", + "responses": { + "200": { + "description": "Status of save form", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "formData": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + } + } + } + } + }, + "/formbuilder/getFormByName/{form_name}": { + "get": { + "summary": "Get Details of Form by Name", + "description": "Get details for a specific form by name", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "form_name", + "in": "path", + "description": "Form name", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.getFormByName", + "responses": { + "200": { + "description": "Forms details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/preserveFormData": { + "post": { + "summary": "Preserve incoming form data format", + "description": "Find and revert containers object/array mutation", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.preserveFormData", + "responses": { + "200": { + "description": "Forms details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "form_name": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + }, + "data": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + } + } + } + } + }, + "/formbuilder/getForm/{form_id}": { + "get": { + "summary": "Get Details of Form by ID", + "description": "Get details for a specific form from by ID", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "form_id", + "in": "path", + "description": "Form ID", + "required": true, + "schema": { + "title": "form_id", + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + } + } + ], + "operationId": "FormBuilder.getForm", + "responses": { + "200": { + "description": "Forms details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/listForms": { + "get": { + "summary": "List All Form Names", + "description": "List the names of all available forms", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.listForms", + "responses": { + "200": { + "description": "Array of form names", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "array", + "items": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + }, + "uniqueItems": true + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/forms/search": { + "post": { + "summary": "Search Forms", + "description": "Search forms with options", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.searchForms", + "responses": { + "200": { + "description": "Array of objects containing forms", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "array", + "items": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "filter": { + "type": "object", + "examples": [ + { + "name": "form_example_1" + } + ] + }, + "startAt": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "maxResults": { + "type": "integer", + "minimum": 0, + "maximum": 100, + "examples": [10] + }, + "sort": { + "type": "object", + "examples": [ + { + "name": 1 + } + ] + }, + "fields": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "children", + "elements", + "createddBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + "examples": [ + [ + "name", + "children", + "elements", + "createddBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + ], + "uniqueItems": true + }, + "expand": { + "type": "array", + "items": { + "type": "string", + "enum": ["createdBy", "lastUpdatedBy"] + }, + "examples": [["createdBy", "lastUpdatedBy"]], + "uniqueItems": true + } + } + } + } + } + } + } + } + } + }, + "/formbuilder/fetchData": { + "post": { + "summary": "Get Service Instance Data", + "description": "Returns service related data", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.fetchData", + "responses": { + "200": { + "description": "Json object of service instance", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "examples": [ + { + "/ncs:services/test:choices": [ + { + "service-name": "service_name_1", + "choice-a": "1" + } + ] + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "FormBuilder.admin", + "FormBuilder.apiwrite", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiwrite", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiwrite", + "FormBuilder.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "service": { + "title": "service", + "type": "string", + "examples": ["/ncs:devices/ncs:device"] + }, + "instance_key": { + "title": "instance_key", + "type": "string", + "examples": ["ncs:name"] + }, + "val": { + "title": "val", + "type": "string", + "examples": ["my_device_01"] + } + } + } + } + } + } + } + }, + "/formbuilder/getElementDefinition/{type}/{id}": { + "get": { + "summary": "Gets an Element Definition.", + "description": "Get the details about a particular element to be used in a form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Element type", + "required": true, + "schema": { + "title": "type", + "type": "string", + "enum": ["service_model", "method"] + } + }, + { + "name": "id", + "in": "path", + "description": "Type ID", + "required": true, + "schema": { + "title": "id", + "type": "string", + "examples": ["/ncs:services/itential_test_devices:multidevice"] + } + } + ], + "operationId": "FormBuilder.getElementDefinition", + "responses": { + "200": { + "description": "Definition of the element", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "examples": [ + { + "children": [], + "type": "service", + "name": "service-name", + "properties": {}, + "key": "s-key", + "namespace": "", + "hosts": ["nso1", "nso2"] + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/listElements": { + "get": { + "summary": "Lists all Elements Usable in Forms", + "description": "Find all elements allowed to be added to a form", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.listElements", + "responses": { + "200": { + "description": "Array of objects containing elements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_elements" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/deleteForm/{id}": { + "post": { + "summary": "Delete a Form by ID", + "description": "Delete a form from the database by its ID", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Form ID", + "required": true, + "schema": { + "title": "id", + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + } + } + ], + "operationId": "FormBuilder.deleteForm", + "responses": { + "200": { + "description": "Status of delete", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] + } + ], + "deprecated": false + } + }, + "/formbuilder/forms/{name}/groups": { + "get": { + "summary": "List Groups for a Form", + "description": "List the groups that have access to a Form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.listFormGroups", + "responses": { + "200": { + "description": "List of Groups", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_groups" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["FormBuilder.apiread", "FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.apiread", "FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.apiread", "FormBuilder.authorization"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Overwrite Groups for a Form", + "description": "Overwrite the list of groups that have access to a Form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.replaceFormGroups", + "responses": { + "200": { + "description": "Status of Overwrite", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.authorization"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "$ref": "#/components/schemas/formbuilder_formDocument_groups" + } + } + } + } + } + } + }, + "post": { + "summary": "Add Group to Form", + "description": "Add a group to the list of groups for a Form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.createFormGroupEntry", + "responses": { + "200": { + "description": "Status of Overwrite", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.authorization"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "$ref": "#/components/schemas/formbuilder_formDocument_ObjectId" + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove all authorization restriction for a Form", + "description": "Clear all groups that can access a form, making it accessible to everyone", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.deleteFormGroups", + "responses": { + "200": { + "description": "Status of Delete", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.authorization"] + } + ], + "deprecated": false + } + }, + "/formbuilder/forms/{name}/groups/{group}": { + "delete": { + "summary": "Remove a Group from a Form", + "description": "Remove a group from the list of authorized groups for a Form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + }, + { + "name": "group", + "in": "path", + "description": "A Group ID", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_ObjectId" + } + } + ], + "operationId": "FormBuilder.removeFormGroup", + "responses": { + "200": { + "description": "Status of Removal", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.authorization"] + } + ], + "deprecated": false + } + }, + "/formbuilder/forms/export": { + "post": { + "summary": "Export Form", + "description": "Export a single Form", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.exportForm", + "responses": { + "200": { + "description": "Exported Form", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["FormBuilder.admin", "FormBuilder.apiread"], + "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiread"], + "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/formbuilder_formDocument_uuidv4" + }, + "name": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + }, + "anyOf": [ + { + "required": ["_id"] + }, + { + "required": ["name"] + } + ], + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/formbuilder/forms/import": { + "post": { + "summary": "Import Form", + "description": "Import a single Form", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.importForm", + "responses": { + "200": { + "description": "Import status", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "form": { + "$ref": "#/components/schemas/formbuilder_formDocument" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "adapterMap": { + "type": "object" + } + } + } + } + } + } + } + } + } + }, + "/search/find": { + "post": { + "summary": "Search IAP", + "description": "Search through IAP for results from various collections that match your search term, as well as for results that have tags that match your search term.", + "tags": ["search"], + "parameters": [], + "operationId": "Search.find", + "responses": { + "200": { + "description": "Search results", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/search_searchResults" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Search.admin", "Search.apiwrite"], + "CookieAuth": ["Search.admin", "Search.apiwrite"], + "BasicAuth": ["Search.admin", "Search.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "text": { + "type": "string", + "examples": ["test"] + }, + "limit": { + "type": "integer", + "examples": [20] + }, + "skip": { + "type": "integer", + "examples": [5] + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/devices": { + "post": { + "summary": "Find Devices", + "description": "Gets a specific subset of devices for based on given options", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDevicesFiltered", + "responses": { + "200": { + "description": "Filtered/Sorted Devices", + "content": { + "application/json": { + "schema": { + "title": "devices", + "type": "object", + "properties": { + "entity": { + "const": "device" + }, + "total": { + "type": "integer", + "minimum": 0 + }, + "unique_device_count": { + "type": "integer", + "minimum": 0 + }, + "return_count": { + "type": "integer", + "minimum": 0 + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceDetails" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "start": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "limit": { + "type": "integer", + "minimum": 1, + "examples": [20] + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "address": { + "type": "string", + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "examples": ["10.1.98.234"] + }, + "port": { + "type": "string", + "pattern": "^[0-9]+$", + "examples": ["22"] + } + } + }, + "sort": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "enum": [-1, 1] + }, + "address": { + "enum": [-1, 1] + }, + "port": { + "enum": [-1, 1] + } + } + } + }, + "order": { + "type": "string", + "enum": ["ascending", "descending"] + }, + "adapterType": { + "type": "array", + "items": { + "type": "string", + "examples": ["NSO", "AnsibleManager"] + }, + "uniqueItems": true + }, + "adapterId": { + "type": "array", + "items": { + "type": "string", + "examples": ["ansible-us-east"], + "uniqueItems": true + } + }, + "exactMatch": { + "type": "boolean", + "description": "boolean that indicates if an exact result will be returned or not", + "enum": [true, false] + } + }, + "required": ["limit"] + } + } + } + } + } + } + } + }, + "/configuration_manager/cache/devices/ostype": { + "post": { + "summary": "Fetches OS Types to store into the cache.", + "description": "Gathers all the device OS Types in the current evnironment and stores them in the cache.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.cacheOSTypes", + "responses": { + "200": { + "description": "Cached OS Type data.", + "content": { + "application/json": { + "schema": { + "title": "cacheData", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "interval": { + "type": "integer", + "description": "Determines how often (in hours) the OS Types are cached.", + "examples": [48] + } + } + } + } + } + } + } + } + }, + "get": { + "summary": "Fetches the OSTypes stored in the cache.", + "description": "Gathers all the device OS Types in the current cache.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getCachedOSTypes", + "responses": { + "200": { + "description": "Cached OS Type data.", + "content": { + "application/json": { + "schema": { + "title": "cacheData", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Deletes the cache for os types.", + "description": "Removes the cache in the database for os type values.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteOSTypeCache", + "responses": { + "200": { + "description": "Deletion response.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "string", + "examples": [ + "Successfully deleted the cache for device os types." + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/pins": { + "delete": { + "summary": "Deletes pinned items.", + "description": "Deletes the pinned items permanently from the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deletePins", + "responses": { + "200": { + "description": "Result of the deletion.", + "content": { + "application/json": { + "schema": { + "title": "result", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pinTargets": { + "title": "pinTargets", + "type": "array", + "items": {} + }, + "sourceItem": { + "title": "sourceItem", + "type": "string" + } + } + } + } + } + } + }, + "post": { + "summary": "Add an item to pins or remove from if it already exists", + "description": "Add an item to pins or remove from if it already exists", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.handlePin", + "responses": { + "200": { + "description": "Pin object with details.", + "content": { + "application/json": { + "schema": { + "title": "pin", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "properties": { + "sourceItem": { + "type": "string", + "example": "cm_device_groups" + }, + "target": { + "type": "string", + "example": "CSR_Devices_Group" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/pins/fetch": { + "post": { + "summary": "Get a list of pinned items.", + "description": "Fetches a list of pinned items based on the input parameters. The list of pinned items are specific to the current user or actor. This api supports pagination.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getPins", + "responses": { + "200": { + "description": "Returns the list of pins and the total count.", + "content": { + "application/json": { + "schema": { + "title": "pins", + "type": "object", + "properties": { + "pins": { + "type": "array", + "items": { + "type": "object" + } + }, + "count": { + "type": "number", + "example": "10" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "properties": { + "filter": { + "type": "object", + "example": "{ sourceItem: 'cm_gc' }" + }, + "start": { + "type": "number", + "example": "0" + }, + "limit": { + "type": "number", + "example": "10" + }, + "projection": { + "type": "object", + "example": "{ users: 0 }" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/ismaintenance": { + "get": { + "summary": "Checks if the current version of CM is maintenance or not.", + "description": "Returns a boolean reflecting whether the current Configuration Manager bundle is a maintenance bundle.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.isMaintenance", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/jinja2": { + "post": { + "summary": "Renders a jinja2 template.", + "description": "Takes a jinja2 template a renders output text.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.renderJinja2", + "responses": { + "200": { + "description": "Returns the list of pins and the total count.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "string", + "examples": ["this is a jinja2 template"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "title": "template", + "type": "string", + "example": "this is a {{ varName }} template" + }, + "variables": { + "title": "variables", + "properties": {} + }, + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/adaptertasks/search": { + "post": { + "summary": "Get data for all adapters with tasks.", + "description": "Fetch method/task metadata for all adapters that have it.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getAdapterTasks", + "responses": { + "200": { + "description": "Output of adapters' metadata.", + "content": { + "application/json": { + "schema": { + "title": "adapterData", + "type": "object", + "properties": { + "adapterTasks": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/adaptertasks": { + "post": { + "summary": "Get data for a specific adapter task.", + "description": "Fetch method/task metadata for an adapter task.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getAdapterTask", + "responses": { + "200": { + "description": "Output of adapter task's metadata.", + "content": { + "application/json": { + "schema": { + "title": "taskData", + "type": "object", + "properties": { + "adapterTasks": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskName": { + "title": "taskName", + "type": "string", + "examples": ["getConfig", "getServiceModel"] + }, + "origin": { + "title": "origin", + "type": "string", + "examples": ["nso52", "localAAA"] + }, + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/instance": { + "post": { + "summary": "Create a task instance.", + "description": "Create an instance of a task and save it to the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createTaskInstance", + "responses": { + "200": { + "description": "Response of whether the insertion operation failed or succeeded.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "instanceName": { + "title": "instanceName", + "type": "string" + }, + "origin": { + "title": "origin", + "type": "string", + "examples": ["nso52", "localAAA"] + }, + "taskName": { + "title": "taskName", + "type": "string", + "examples": ["getConfig", "getServiceModel"] + }, + "treeId": { + "title": "treeId", + "type": "string", + "examples": ["5f21c92ba6abf82bf5041783"] + }, + "taskParams": { + "title": "taskParams", + "properties": {} + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + }, + "put": { + "summary": "Update a task instance.", + "description": "Update an instance of a task and save it to the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateTaskInstance", + "responses": { + "200": { + "description": "Response of whether the update operation failed or succeeded.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskId": { + "title": "taskId", + "type": "string" + }, + "treeId": { + "title": "treeId", + "type": "string" + }, + "taskParams": { + "title": "taskParams", + "type": "object", + "properties": {} + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete task instance(s).", + "description": "Delete task instance(s) from the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteTaskInstances", + "responses": { + "200": { + "description": "Response of whether the delete operation failed or succeeded.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskIds": { + "title": "taskIds", + "type": "array", + "properties": {}, + "items": {} + }, + "treeId": { + "title": "treeId", + "type": "string" + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/instances": { + "post": { + "summary": "Get task instance(s).", + "description": "Get instance(s) of a task.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getTaskInstances", + "responses": { + "200": { + "description": "Response of whether the get operation failed or succeded (with data).", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "title": "treeId", + "type": "string", + "examples": ["5f21c92ba6abf82bf5041783"] + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "filter": { + "type": "object", + "example": "{ 'instanceName': 'some task instance 1' }" + }, + "nodePath": { + "type": "string", + "example": "base" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/instances/search": { + "post": { + "summary": "Search for task instance(s).", + "description": "Search for task instance(s) using varies options parameters.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchTaskInstances", + "responses": { + "200": { + "description": "Response of whether the get operation failed or succeded (with data).", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "filter": { + "type": "object", + "example": "{ 'instanceName': 'some task instance 1' }" + }, + "nodePath": { + "type": "string", + "example": "base" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/instance/run": { + "post": { + "summary": "Run a task instance.", + "description": "Run an instance of a task and save it to the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runTaskInstance", + "responses": { + "200": { + "description": "Data returned by the execution of the task instance..", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskId": { + "title": "taskId", + "type": "string" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/run": { + "post": { + "summary": "Run an adapter task.", + "description": "Run an adapter task.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runAdapterTask", + "responses": { + "200": { + "description": "Data returned by the exection of the adapter task.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "origin": { + "title": "origin", + "type": "string" + }, + "taskName": { + "title": "taskName", + "type": "string" + }, + "args": { + "title": "args", + "type": "object", + "properties": {} + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/{name}": { + "get": { + "summary": "Get Device Details", + "description": "Get detailed information for a specific device, based on its device name", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.getDevice", + "responses": { + "200": { + "description": "Device's details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceDetails" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/devices/{name}/configuration": { + "get": { + "summary": "Get Device Configuration", + "description": "Get configuration for a specific device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.getDeviceConfig", + "responses": { + "200": { + "description": "Configuration for a specific device", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/devices/{name}/configuration/{format}": { + "get": { + "summary": "Get formatted device config", + "description": "Get device configuration in a given format.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + { + "name": "format", + "in": "path", + "description": "Supported formats by NSO (xml, native, json) & Automation Gateway (native).", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfigurationFormat" + } + } + ], + "operationId": "ConfigurationManager.getDeviceConfigFormat", + "responses": { + "200": { + "description": "Configuration for a specific device", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": true + } + }, + "/configuration_manager/devices/backups": { + "post": { + "summary": "Backup device configuration", + "description": "Backup device configuration in mongo", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.backUpDevice", + "responses": { + "200": { + "description": "Status of backup operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "Device {deviceName} backed up successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backupDescription" + }, + "notes": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backupNotes" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/import/backups": { + "post": { + "summary": "Import backup documents", + "description": "Insert backup documents into the ucm_configs collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importBackup", + "responses": { + "200": { + "description": "Status of backup import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 device backups imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "backups": { + "title": "backups", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backup" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/import/groups": { + "post": { + "summary": "Import device group documents", + "description": "Insert device group documents into the device_groups collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importGroup", + "responses": { + "200": { + "description": "Status of group import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 device groups imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "title": "groups", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_groupDetails" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/backups": { + "post": { + "summary": "Get Device Backup List", + "description": "Fetches backups, requires an options payload. An empty option payload will return the first 25 documents", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getBackups", + "responses": { + "200": { + "description": "List of all backups and the total", + "content": { + "application/json": { + "schema": { + "title": "backups", + "type": "object", + "properties": { + "total": { + "type": "integer", + "minimum": 0 + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backup" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "start": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "limit": { + "type": "integer", + "minimum": 1, + "examples": [20] + }, + "regex": { + "type": "boolean" + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "dateRange": { + "type": "array", + "description": "An array containing the start and end date. Index 0 = start date, index 1 = end date.", + "items": {} + }, + "sort": { + "type": "object", + "properties": { + "name": { + "enum": [-1, 1] + }, + "date": { + "enum": [-1, 1] + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete one or more device backups by Id", + "description": "This API call will delete device backups based on given Ids", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDeviceBackups", + "responses": { + "200": { + "description": "Status with the number of device backups deleted", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "deleted": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "backupIds": { + "title": "backupIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/backups/list": { + "get": { + "summary": "Gets a list of all backed up devices", + "description": "Returns a list of devices that have one or more backups", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getBackedUpDevices", + "responses": { + "200": { + "description": "List of devices with backups", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/backups/{id}": { + "get": { + "summary": "Get Device Backup", + "description": "Retrieves single backup document by id", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Backup's id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getDeviceBackupById", + "responses": { + "200": { + "description": "JSON object that contains the backed up configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backup" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update a device backup by Id", + "description": "This API call will update the metadata of a device backup by ID", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Backup Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateDeviceBackupById", + "responses": { + "200": { + "description": "Status of the device backup updated", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "updated": { + "type": "integer", + "enum": [0, 1] + } + }, + "required": ["status", "updated"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backupDescription" + }, + "notes": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backupNotes" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/name/devicegroups": { + "get": { + "summary": "Get Device Group by Name", + "description": "Retrieves a single group document by name", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDeviceGroupByName", + "responses": { + "200": { + "description": "JSON object that contains the device group details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupName": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + } + } + } + } + } + } + } + }, + "/configuration_manager/groups/device/{deviceName}": { + "get": { + "summary": "Gets device groups for a device", + "description": "Finds all the device groups that contain the specified device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.getGroupsForDevice", + "responses": { + "200": { + "description": "List of device groups found", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/devices/{name}/isAlive": { + "get": { + "summary": "Check if device is connected", + "description": "Get connection status of device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.isAlive", + "responses": { + "200": { + "description": "Status of device connection", + "content": { + "application/json": { + "schema": { + "title": "status", + "oneOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/devicegroup": { + "post": { + "summary": "Creates a device group", + "description": "Creates a new device group in pronghorn", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createDeviceGroup", + "responses": { + "200": { + "description": "Result of creating a new device group", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_createGroupResponseWithName" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupName": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + }, + "groupDescription": { + "$ref": "#/components/schemas/configuration_manager_common_standardDescription" + }, + "deviceNames": { + "$ref": "#/components/schemas/configuration_manager_common_multiElementString" + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups": { + "get": { + "summary": "Get all Device Groups", + "description": "Gets a list of all known device groups", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDeviceGroups", + "responses": { + "200": { + "description": "List of device groups found", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Delete device groups", + "description": "Delete specified device groups", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDeviceGroups", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_deleteGroupResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupIds": { + "title": "groupIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/search": { + "post": { + "summary": "Search all Device Groups", + "description": "Gets a list of all device groups that match the search criteria", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchDeviceGroups", + "responses": { + "200": { + "description": "List of device groups that match the search criteria", + "content": { + "application/json": { + "schema": { + "title": "deviceGroups", + "type": "object", + "properties": { + "totalCount": { + "type": "number" + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "s": { + "title": "s", + "type": "string" + }, + "start": { + "title": "start", + "type": "number" + }, + "limit": { + "title": "limit", + "type": "number" + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/query": { + "post": { + "summary": "Search device groups", + "description": "Returns device groups that match the specified input", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchGroups", + "responses": { + "200": { + "description": "List of device groups that match the search criteria", + "content": { + "application/json": { + "schema": { + "title": "deviceGroups", + "type": "object", + "properties": { + "totalCount": { + "type": "number" + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "start": { + "title": "start", + "type": "number" + }, + "limit": { + "title": "limit", + "type": "number" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "regex": { + "type": "boolean", + "description": "Enables global regex/substring search." + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/{id}": { + "get": { + "summary": "Get Device Group by ID", + "description": "Get Device Group by ID", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Group Id or Group Name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getDeviceGroupById", + "responses": { + "200": { + "description": "JSON object that contains the device group details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update device groups", + "description": "Updates the device group's details and devices.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Group Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateDeviceGroups", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "details": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupDetails" + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/{id}/devices": { + "delete": { + "summary": "Removes devices from a group", + "description": "Removes devices from a device group", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "ConfigurationManager.removeDevicesFromGroup", + "responses": { + "200": { + "description": "Result of removing devices", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "devices": { + "title": "devices", + "type": "array", + "properties": {}, + "items": {} + } + } + } + } + } + } + }, + "post": { + "summary": "Adds new devices to the group", + "description": "Adds devices to a group", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "ConfigurationManager.addDevicesToGroup", + "responses": { + "200": { + "description": "Result of adding new devices to the group", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "devices": { + "title": "devices", + "type": "array", + "properties": {}, + "items": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/name/deviceGroups": { + "delete": { + "summary": "Delete device groups", + "description": "Delete specified device groups", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDeviceGroupsByName", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_deleteGroupResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupNames": { + "title": "groupNames", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/devices": { + "post": { + "summary": "Add device(s) to a group", + "description": "This API call will add device(s) to a device group", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.addDevicesToGroupByName", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupName": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + }, + "deviceNames": { + "$ref": "#/components/schemas/configuration_manager_common_multiElementString" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete device(s) from a group", + "description": "This API call will delete device(s) from a device group", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDevicesFromGroup", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupName": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + }, + "deviceNames": { + "$ref": "#/components/schemas/configuration_manager_common_multiElementString" + } + } + } + } + } + } + } + }, + "/configuration_manager/lookup_diff": { + "put": { + "summary": "Diff two strings from a lookup.", + "description": "Lookup two strings and return a diff.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.lookupDiff", + "responses": { + "200": { + "description": "diffResult", + "content": { + "application/json": { + "schema": { + "title": "diffResult", + "type": "array", + "items": { + "type": "array" + }, + "examples": [ + [ + [-1, "version 16.12"], + [1, "Building configuration..."], + [0, "service timestamps debug datetime"], + [-1, "msec"], + [0, "localtime"] + ] + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "nextId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "collection": { + "title": "collection", + "type": "string", + "minLength": 1 + }, + "nextCollection": { + "title": "nextCollection", + "type": "string", + "minLength": 1 + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "type": { + "type": "boolean" + }, + "clean": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configurations/parser": { + "post": { + "summary": "Create a config parser.", + "description": "Create rules for a parser for breaking down configs in GC.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createConfigParser", + "responses": { + "200": { + "description": "data", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "minLength": 1 + }, + "lexRules": { + "title": "lexRules", + "items": { + "title": "lexRule", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + ["^{", "open_statement_block"], + ["^}", "close_statement_block"] + ] + } + }, + "template": { + "title": "template", + "type": "string", + "enum": ["cisco-ios", "f5-bigip"] + } + } + } + } + } + } + }, + "put": { + "summary": "Update a config parser.", + "description": "Update rules for a parser for breaking down configs in GC.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateConfigParser", + "responses": { + "200": { + "description": "result", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "updated": { + "type": "number" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "minLength": 1 + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "lexRules": { + "type": "array", + "items": { + "title": "ruleDefinitions", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + ["^{", "open_statemen_block"], + ["^}", "close_statemen_block"] + ] + } + }, + "template": { + "type": "string", + "examples": ["cisco-ios"] + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a config parser.", + "description": "Permanently delete a configuration parser.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteConfigParser", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "minLength": 1 + }, + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + }, + "get": { + "summary": "Get all config parsers.", + "description": "Gets a list of all known config parsers.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "start", + "in": "query", + "description": "start", + "required": false, + "schema": { + "type": "integer", + "minimum": 0, + "examples": [0] + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "examples": [20] + } + }, + { + "name": "regex", + "in": "query", + "description": "regex", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "filter", + "in": "query", + "description": "filter", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "integer", + "enum": [-1, 1] + }, + "date": { + "type": "integer", + "enum": [-1, 1] + } + } + } + } + ], + "operationId": "ConfigurationManager.getConfigParsers", + "responses": { + "200": { + "description": "List of config parsers found", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "array", + "items": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/configurations/parser/search": { + "post": { + "summary": "Get a config parser.", + "description": "Get a defined Config Parser from the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getConfigParser", + "responses": { + "200": { + "description": "data", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": { + "parser": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filter": { + "title": "filter", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/configurations/parsers": { + "delete": { + "summary": "Delete one or more config parsers by Id", + "description": "This API call will delete config parsers based on given Ids", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteConfigParsers", + "responses": { + "200": { + "description": "Status with the number of config parsers deleted", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "deleted": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "parserIds": { + "title": "parserIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/import/parsers": { + "post": { + "summary": "Import parser documents", + "description": "Insert parser documents into the ucm_configs collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importParsers", + "responses": { + "200": { + "description": "Status of parser import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 device parsers imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "parsers": { + "title": "parsers", + "type": "array", + "items": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/configs": { + "get": { + "summary": "Get a list of all Golden Config trees.", + "description": "Get a list of all Golden Config trees.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getGoldenConfigTrees", + "responses": { + "200": { + "description": "List of all Golden Config trees", + "content": { + "application/json": { + "schema": { + "title": "goldenConfigTrees", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Adds a new Golden Config tree", + "description": "Adds a new Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createGoldenConfigTree", + "responses": { + "200": { + "description": "details of the initial version of the newly created tree", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": [ + "Cisco Edge - Day 0", + "Cisco Edge - Day 1", + "Cisco Core - Day 0", + "Cisco Core - Day 1" + ] + }, + "deviceType": { + "title": "deviceType", + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete one or more golden configuration trees by tree id", + "description": "This API call will delete golden configuration trees based on given tree ids", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteGoldenConfigTrees", + "responses": { + "200": { + "description": "Status with the number of golden configurations deleted", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "deleted": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeIds": { + "title": "treeIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/{treeId}": { + "get": { + "summary": "Get summary of a Golden Config tree.", + "description": "Get summary of the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getGoldenConfigTree", + "responses": { + "200": { + "description": "Requested Golden Config tree", + "content": { + "application/json": { + "schema": { + "title": "tree", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Adds a new Golden Config tree", + "description": "Adds a new Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "ID of the new Golden Config tree", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.createGoldenConfigTreeVersion", + "responses": { + "200": { + "description": "details of the initial version of the newly created tree", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "base": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + } + } + } + } + }, + "put": { + "summary": "Updates properties of a Golden Config tree", + "description": "Updates properties of the specified Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateGoldenConfigTree", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config tree updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["GC Tree Name"] + }, + "gbac": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a Golden Config tree.", + "description": "Deletes the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.deleteGoldenConfigTree", + "responses": { + "200": { + "description": "Result of the delete request", + "content": { + "application/json": { + "schema": { + "title": "deleteResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config tree deleted"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/configs/{treeId}/{version}": { + "get": { + "summary": "Get details of a Golden Config tree version.", + "description": "Get a detailed view of the specified Golden Config tree version.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + ], + "operationId": "ConfigurationManager.getGoldenConfigTreeVersion", + "responses": { + "200": { + "description": "Requested Golden Config tree version", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates properties of a Golden Config tree version", + "description": "Updates properties of the specified Golden Config tree version", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + ], + "operationId": "ConfigurationManager.updateGoldenConfigTreeVersion", + "responses": { + "200": { + "description": "status of creation and the new tree, if successful", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Configuration tree version updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["updated version name"] + }, + "variables": { + "title": "variables", + "type": "object", + "properties": {} + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a Golden Config tree.", + "description": "Deletes the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + ], + "operationId": "ConfigurationManager.deleteGoldenConfigTreeVersion", + "responses": { + "200": { + "description": "Result of the delete request", + "content": { + "application/json": { + "schema": { + "title": "deleteResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Configuration tree version deleted"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/search/configs": { + "post": { + "summary": "Get summary of a Golden Config tree.", + "description": "Get summary of the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchGoldenConfigTrees", + "responses": { + "200": { + "description": "List of all Golden Config trees", + "content": { + "application/json": { + "schema": { + "title": "goldenConfigTrees", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "properties": { + "start": { + "type": "number", + "example": "0" + }, + "limit": { + "type": "number", + "example": "10" + }, + "sort": { + "type": "number", + "example": 1 + }, + "deviceType": { + "type": "string", + "example": "cisco-ios" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/device/trees": { + "post": { + "summary": "Find trees which contain the specified device.", + "description": "Search through all GC Trees to find all locations where a device exists.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getTreesForDevice", + "responses": { + "200": { + "description": "List of trees that the device belongs to.", + "content": { + "application/json": { + "schema": { + "title": "trees", + "type": "array", + "items": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/tree": { + "post": { + "summary": "Fetches all the devices that exist on a tree.", + "description": "Search through a GC Tree to find all the devices that exist on it.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDevicesOnTree", + "responses": { + "200": { + "description": "Response containing the list of devices.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "nodes": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/variables/{treeId}/{version}": { + "delete": { + "summary": "Deletes one or more variables", + "description": "Verifies and deletes the requested deletion variables", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + ], + "operationId": "ConfigurationManager.deleteVariables", + "responses": { + "200": { + "description": "status of the variables to delete", + "content": { + "application/json": { + "schema": { + "title": "deleteResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Deletion successful."] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "variables": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigVariables" + } + } + } + } + } + } + } + }, + "/configuration_manager/configurations/rules": { + "put": { + "summary": "Updates the config rule set of a JSON Golden Config tree version", + "description": "Updates the config rule set of a JSON Golden Config tree version", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateJSONConfigRules", + "responses": { + "200": { + "description": "status of the rule set update.", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Rule Set successfully updated."] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "ruleSet": { + "title": "ruleSet", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/devices/groups": { + "delete": { + "summary": "Remove Device Groups from Node", + "description": "Remove device groups from a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.removeGroupsFromNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "deviceGroups": { + "title": "deviceGroups", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Add Device Groups to Node", + "description": "Add device groups to a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.addGroupsToNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "deviceGroups": { + "title": "deviceGroups", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/export/goldenconfigs": { + "post": { + "summary": "Export a Golden Config tree.", + "description": "Exports the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.exportGoldenConfigTree", + "responses": { + "200": { + "description": "Dereferenced golden config tree", + "content": { + "application/json": { + "schema": { + "title": "exportResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "data": { + "type": "array", + "title": "data", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + }, + "/configuration_manager/import/goldenconfigs": { + "post": { + "summary": "Import golden config tree documents", + "description": "Insert golden config documents into the golden config collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importGoldenConfigTree", + "responses": { + "200": { + "description": "Status of golden config import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 golden config trees imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "trees": { + "title": "trees", + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "array", + "description": "Documents of given tree per version", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/node/tasks": { + "delete": { + "summary": "Remove Tasks from Node", + "description": "Remove Tasks from a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.removeTasksFromNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "tasks": { + "title": "tasks", + "type": "array", + "items": { + "type": "string", + "title": "taskId", + "examples": ["5f9700486aa2ad95d85fc973"] + } + } + } + } + } + } + } + }, + "post": { + "summary": "Add Tasks to Node", + "description": "Add Tasks to a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.addTasksToNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "tasks": { + "title": "tasks", + "type": "array", + "items": { + "type": "string", + "title": "taskId", + "examples": ["5f9700486aa2ad95d85fc973"] + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/{treeId}/{version}/{nodePath(*)}/devices": { + "post": { + "summary": "Add Devices to Node", + "description": "Add devices to a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.addDevicesToNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "devices": { + "title": "devices", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove Devices from Node", + "description": "Remove devices from a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.removeDevicesFromNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "devices": { + "title": "devices", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/{treeId}/{version}/{parentNodePath(*)}": { + "post": { + "summary": "Create a new node in a Golden Config tree.", + "description": "Create a new node in the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "parentNodePath", + "in": "path", + "description": "parentNodePath", + "required": true, + "schema": { + "title": "parentNodePath", + "type": "string", + "examples": ["base/US East"] + } + } + ], + "operationId": "ConfigurationManager.createGoldenConfigNode", + "responses": { + "200": { + "description": "Newly created node", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNode" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["DC"] + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/{treeId}/{version}/{nodePath(*)}": { + "put": { + "summary": "Update properties of a node in a Golden Config tree.", + "description": "Update properties of the specified Golden Config node.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.updateGoldenConfigNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["Southeast"] + }, + "attributes": { + "title": "attributes", + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "configId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a node in a Golden Config tree.", + "description": "Permanently delete the specified node in the Golden Config tree. Not reversible.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.deleteGoldenConfigNode", + "responses": { + "200": { + "description": "deleteNodeResult", + "content": { + "application/json": { + "schema": { + "title": "deleteNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Configuration node deleted"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/config_specs/{id}": { + "get": { + "summary": "Get a Config Spec document.", + "description": "Get the details of the specified Config Spec.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getConfigSpec", + "responses": { + "200": { + "description": "configSpec", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpec" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update a Config Spec.", + "description": "Update content of the Config Spec.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateConfigSpec", + "responses": { + "200": { + "description": "configSpecUpdateResult", + "content": { + "application/json": { + "schema": { + "title": "configSpecUpdateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Config Spec updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "template": { + "type": "string", + "examples": ["ntp server {{ ipAddress }}"] + }, + "variables": { + "type": "string", + "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/config_template": { + "post": { + "summary": "Get a Config Spec template.", + "description": "Get the template of the specified Config Spec", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getConfigTemplate", + "responses": { + "200": { + "description": "template", + "content": { + "application/json": { + "schema": { + "title": "template", + "type": "object", + "properties": { + "currentTemplate": { + "type": "string" + }, + "inheritedTemplate": { + "type": "string" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/config_specs": { + "post": { + "summary": "Create a new Config Spec.", + "description": "Create a new Config Spec.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createConfigSpec", + "responses": { + "200": { + "description": "configSpec", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpec" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceType": { + "title": "deviceType", + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "data": { + "title": "data", + "type": "object", + "properties": { + "template": { + "type": "string", + "examples": ["ntp server {{ ipAddress }}"] + }, + "variables": { + "type": "string", + "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/node/config": { + "put": { + "summary": "Update node configuration.", + "description": "Updates the configuration for a specified node.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateNodeConfig", + "responses": { + "200": { + "description": "nodeUpdateResult", + "content": { + "application/json": { + "schema": { + "title": "nodeUpdateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Node Config updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "treeVersion": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "data": { + "title": "data", + "type": "object", + "properties": { + "template": { + "type": "string", + "examples": ["ntp server {{ ipAddress }}"] + }, + "variables": { + "type": "string", + "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] + } + } + }, + "updateVariables": { + "title": "updateVariables", + "type": "boolean" + } + } + } + } + } + } + } + }, + "/configuration_manager/translate/config_spec": { + "post": { + "summary": "Convert a config spec into a readable string.", + "description": "Converts a object like config into a human-readable config string.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.translateConfigSpec", + "responses": { + "200": { + "description": "configData", + "content": { + "application/json": { + "schema": { + "title": "configData", + "type": "object", + "properties": { + "config": { + "type": "string", + "examples": [ + "interface Loopback01\n description loopback01" + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeID": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/generate/config_spec": { + "post": { + "summary": "Builds a config spec from raw config.", + "description": "Takes raw native config and builds a configuration spec.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.buildSpecLines", + "responses": { + "200": { + "description": "specLines", + "content": { + "application/json": { + "schema": { + "title": "specLines", + "type": "array", + "properties": {}, + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecLine" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nativeConfig": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfigurationString" + }, + "deviceType": { + "title": "deviceType", + "type": "string", + "enum": [ + "cisco-ios", + "cisco-asa", + "cisco-ios-xr", + "cisco-nx", + "cisco-staros", + "alu-sr", + "a10-acos", + "juniper-junos", + "f5-bigip", + "arista-eos" + ] + }, + "options": { + "title": "options", + "properties": {}, + "type": "object" + } + } + } + } + } + } + } + }, + "/configuration_manager/json_specs/{id}": { + "get": { + "summary": "Get a JSON Spec document.", + "description": "Get the details of the specified JSON Spec.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getJSONSpec", + "responses": { + "200": { + "description": "JSONSpec", + "content": { + "application/json": { + "schema": { + "title": "JSONSpec", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update a JSON Spec", + "description": "Update content of the JSON Spec.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateJSONSpec", + "responses": { + "200": { + "description": "jsonSpecUpdateResult", + "content": { + "application/json": { + "schema": { + "title": "jsonSpecUpdateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["JSON Spec updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/json_specs": { + "post": { + "summary": "Get a JSON Spec document with inheritance.", + "description": "Get the details of the specified JSON Spec with inheritance.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getJSONSpecWithInheritance", + "responses": { + "200": { + "description": "JSONSpec", + "content": { + "application/json": { + "schema": { + "title": "JSONSpec", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/json_specs/create": { + "post": { + "summary": "Create a new JSON Spec.", + "description": "Create a new JSON Spec.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createJSONSpec", + "responses": { + "200": { + "description": "jsonSpec", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigJSONSpec" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/config": { + "post": { + "summary": "Run Compliance Reports.", + "description": "Kick off one or more compliance checks for devices in a specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runConfigCompliance", + "responses": { + "200": { + "description": "runComplianceBatchResult", + "content": { + "application/json": { + "schema": { + "title": "runComplianceBatchResult", + "type": "object", + "properties": { + "status": { + "type": "integer", + "const": 202 + }, + "message": { + "type": "string", + "examples": ["compliance batch ${batchId} started"] + }, + "batchId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceName": { + "title": "deviceName", + "type": "string", + "examples": ["Cisco-Device.1"] + }, + "configuration": { + "title": "configuration", + "type": "string", + "examples": [ + "interface Loopback1\n ip address 10.0.0.1\nntp server 105.62.30.158" + ] + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports": { + "post": { + "summary": "Run Compliance Reports.", + "description": "Kick off one or more compliance checks for devices in a specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runCompliance", + "responses": { + "200": { + "description": "runComplianceBatchResult", + "content": { + "application/json": { + "schema": { + "title": "runComplianceBatchResult", + "type": "object", + "properties": { + "status": { + "type": "integer", + "const": 202 + }, + "message": { + "type": "string", + "examples": ["compliance batch ${batchId} started"] + }, + "batchId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "tasks": { + "type": "array", + "items": { + "type": "string" + }, + "examples": ["5f7b4c5ab2f4e0690520eed2"] + }, + "variables": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigVariables" + }, + "bidirectional": { + "type": "boolean" + } + }, + "required": ["treeId", "version"] + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/backups": { + "post": { + "summary": "Run Compliance Reports on Backups.", + "description": "Kick off one or more compliance checks for backups in a specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runComplianceOnBackups", + "responses": { + "200": { + "description": "runComplianceBatchResult", + "content": { + "application/json": { + "schema": { + "title": "runComplianceBatchResult", + "type": "object", + "properties": { + "status": { + "type": "integer", + "const": 202 + }, + "message": { + "type": "string", + "examples": ["compliance batch ${batchId} started"] + }, + "batchId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeInfo": { + "title": "treeInfo", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + } + }, + "required": ["treeId", "version", "nodePath"] + }, + "backupIds": { + "title": "backupIds", + "type": "array", + "items": { + "type": "string", + "title": "backupId", + "examples": ["5f9700486aa2ad95d85fc973"] + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "bidirectional": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/tree/{treeId}": { + "get": { + "summary": "Summarize Compliance Reports for a Tree.", + "description": "Summarize Compliance Reports for a Tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getComplianceReportTreeSummary", + "responses": { + "200": { + "description": "complianceSummary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceSummary" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/compliance_reports/node/{treeId}/{nodePath(*)}": { + "get": { + "summary": "Summarize Compliance Reports for a Node.", + "description": "Summarize Compliance Reports for a Node.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.getComplianceReportNodeSummary", + "responses": { + "200": { + "description": "complianceSummary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceSummary" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/compliance_reports/grade": { + "post": { + "summary": "Get graded compliance reports for a node.", + "description": "Get a set of graded and scored compliance reports for a node.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.gradeComplianceReports", + "responses": { + "200": { + "description": "graded_compliance_reports", + "content": { + "application/json": { + "schema": { + "title": "graded_compliance_reports", + "type": "array", + "items": { + "type": "object", + "properties": { + "grade": { + "type": "string", + "examples": ["pass", "review", "fail"] + }, + "total": { + "type": "integer", + "minimum": 0 + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "records": { + "type": "array", + "items": { + "type": "object", + "properties": { + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "reportId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "timestamp": { + "$ref": "#/components/schemas/configuration_manager_common_timestamp" + }, + "score": { + "type": "number" + }, + "grade": { + "type": "string", + "examples": ["pass", "review", "fail"] + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "options": { + "title": "options", + "allOf": [ + { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_reportGradingOptions" + }, + { + "type": "object", + "properties": { + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + } + ] + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/grade/single": { + "post": { + "summary": "Grade Report", + "description": "Get graded compliance report", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.gradeComplianceReport", + "responses": { + "200": { + "description": "graded_compliance_report", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportGraded" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reportId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_reportGradingOptions" + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/grade/history": { + "post": { + "summary": "Get historical graded compliance reports.", + "description": "Get historical graded compliance reports for a device on a node.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.gradeDeviceComplianceHistory", + "responses": { + "200": { + "description": "graded_compliance_history", + "content": { + "application/json": { + "schema": { + "title": "graded_compliance_history", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "options": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" + } + } + } + } + } + } + } + }, + "/configuration_manager/json_compliance_reports/grade/history": { + "post": { + "summary": "Get historical graded compliance reports.", + "description": "Get historical graded compliance reports for a task instance on a node.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.gradeTaskComplianceHistory", + "responses": { + "200": { + "description": "graded_compliance_history", + "content": { + "application/json": { + "schema": { + "title": "graded_compliance_history", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "taskId": { + "title": "taskId", + "type": "string", + "examples": ["5f80bd24f8479975bb46054d"] + }, + "options": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/query/history": { + "post": { + "summary": "Get historical graded compliance reports with pagination support.", + "description": "Get historical graded compliance reports for a device on a node with pagination support.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.queryGradedComplianceHistory", + "responses": { + "200": { + "description": "graded_compliance_history", + "content": { + "application/json": { + "schema": { + "title": "graded_compliance_history", + "properties": { + "total": { + "title": "total", + "type": "number" + }, + "history": { + "title": "history", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "filter": { + "title": "filter", + "properties": { + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "taskId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + }, + "options": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/batch/{batchId}": { + "get": { + "summary": "Get compliance report metadata for a batch.", + "description": "Get compliance report metadata by batch ID.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "batchId", + "in": "path", + "description": "batchId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getComplianceReportsByBatch", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/json_compliance_reports/batch/{batchId}": { + "get": { + "summary": "Get compliance report metadata for a batch.", + "description": "Get compliance report metadata by batch ID.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "batchId", + "in": "path", + "description": "batchId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getJSONComplianceReportsByBatch", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/compliance_reports/history": { + "post": { + "summary": "Compliance Reports totals for a Device.", + "description": "Compliance Reports totals for a Device.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getComplianceReportDeviceHistory", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "limit": { + "type": "integer", + "minimum": 1 + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/history/backups": { + "post": { + "summary": "Compliance Reports totals for a Backup.", + "description": "Compliance Reports totals for a Backup.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getComplianceReportBackupHistory", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "backups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "limit": { + "type": "integer", + "minimum": 1 + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/json_compliance_reports/history": { + "post": { + "summary": "Compliance Reports totals for a Task Instance.", + "description": "Compliance Reports totals for a Task Instance.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getComplianceReportTaskHistory", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "taskIds": { + "type": "array", + "items": { + "type": "string", + "title": "taskIds", + "examples": ["5f1063d78cf3b62347de4b87"] + } + }, + "limit": { + "type": "integer", + "minimum": 1 + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/details/{reportId}": { + "get": { + "summary": "Get Compliance Report", + "description": "Get the details of a particular compliance report", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "reportId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getComplianceReportDetail", + "responses": { + "200": { + "description": "complianceReportDetail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/json_compliance_reports/details/{reportId}": { + "get": { + "summary": "Get JSON Compliance Report", + "description": "Get the details of a particular JSON compliance report", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "reportId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getJSONComplianceReportDetail", + "responses": { + "200": { + "description": "complianceReportDetail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/compliance_reports/details": { + "post": { + "summary": "Get details of a particular set of compliance checks.", + "description": "Get details of a particular set of compliance checks.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getComplianceReportsDetail", + "responses": { + "200": { + "description": "complianceReportsDetail", + "content": { + "application/json": { + "schema": { + "title": "complianceReportsDetail", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reportIds": { + "title": "reportIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/topissues": { + "post": { + "summary": "Get the top issues from compliance reports", + "description": "Get the top most offending issues from all latest compliance reports", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getTopIssues", + "responses": { + "200": { + "description": "topIssuesResults", + "content": { + "application/json": { + "schema": { + "title": "topIssuesResults", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecLineId" + }, + "specWords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecWord" + } + }, + "count": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/json_compliance_reports/topissues": { + "post": { + "summary": "Get the top issues from JSON compliance reports", + "description": "Get the top most offending issues from all latest JSON compliance reports", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getTopIssuesJson", + "responses": { + "200": { + "description": "topIssuesResults", + "content": { + "application/json": { + "schema": { + "title": "topIssuesResults", + "type": "array", + "items": { + "type": "object", + "properties": {} + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/patch_device/{deviceName}": { + "post": { + "summary": "Alters a device configuration", + "description": "Apply specified changes to a device configuration", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "deviceName", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.patchDeviceConfiguration", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "patchResult", + "type": "object", + "properties": { + "response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "boolean" + }, + "parents": { + "type": "array", + "items": { + "type": "string" + } + }, + "new": { + "type": "string" + }, + "old": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "changes": { + "title": "changes", + "type": "array", + "items": { + "type": "object", + "properties": { + "parents": { + "type": "array", + "items": { + "type": "string", + "examples": ["parent line of config"] + } + }, + "old": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["old config line", null] + }, + "new": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["new config line", null] + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/patch_device/advanced/{deviceName}": { + "post": { + "summary": "Alters a device configuration", + "description": "Apply specified changes to a device configuration with additional options", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "deviceName", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.advancedPatchDeviceConfiguration", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "patchResult", + "type": "object", + "properties": { + "response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "boolean" + }, + "parents": { + "type": "array", + "items": { + "type": "string" + } + }, + "new": { + "type": "string" + }, + "old": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "changes": { + "title": "changes", + "type": "array", + "items": { + "type": "object", + "properties": { + "parents": { + "type": "array", + "items": { + "type": "string", + "examples": ["parent line of config"] + } + }, + "old": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["old config line", null] + }, + "new": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["new config line", null] + } + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "backupDevice": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/changes/convert": { + "post": { + "summary": "Converts patch data to native config.", + "description": "Converts the config patch data into a readable native config.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.convertChangesToConfig", + "responses": { + "200": { + "description": "configData", + "content": { + "application/json": { + "schema": { + "title": "configData", + "type": "object", + "properties": { + "config": { + "type": "string", + "examples": [ + "interface Loopback01\n description loopback01" + ] + }, + "changes": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceType": { + "title": "deviceType", + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "changes": { + "title": "changes", + "type": "array", + "items": { + "type": "object", + "properties": { + "parents": { + "type": "array", + "items": { + "type": "string", + "examples": ["parent line of config"] + } + }, + "old": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["old config line", null] + }, + "new": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["new config line", null] + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/actions/{device&:origin&:action}": { + "get": { + "summary": "Call Adapter Method", + "description": "Perform south bound specific logic via direct adapter call(s)", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "device", + "in": "path", + "description": "device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + { + "name": "origin", + "in": "path", + "description": "origin name", + "required": true, + "schema": { + "title": "origin", + "type": "string", + "examples": ["nso46", "ansible-us"] + } + }, + { + "name": "action", + "in": "path", + "description": "adapter action/function to be called", + "required": true, + "schema": { + "title": "action", + "type": "string", + "examples": ["checkSync"] + } + } + ], + "operationId": "ConfigurationManager.adapterProxy", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "adapterResponse", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/templates": { + "post": { + "summary": "Creates a device template", + "description": "Creates a new device template in pronghorn", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createDeviceTemplate", + "responses": { + "200": { + "description": "Result of creating a new device template", + "content": { + "application/json": { + "schema": { + "title": "data", + "properties": { + "result": { + "type": "string", + "example": "success" + }, + "data": { + "type": "object", + "example": { + "id": "610315295595a5fcb99f8ce2", + "name": "Cisco Login Banner", + "template": "banner login {{ bannerBody }}", + "variables": { + "bannerBody": "Welcome to this Cisco Device." + }, + "created": "2021-07-29T20:52:57.378Z", + "updated": "2021-07-29T20:52:57.378Z", + "createdBy": "5eaaf3796b16027c8aeb612a", + "updatedBy": "5eaaf3796b16027c8aeb612a", + "gbac": { + "write": [], + "read": [] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "template": { + "title": "template", + "type": "string", + "examples": [ + "interface Loopback1\n description {{ description }}" + ] + }, + "variables": { + "title": "variables", + "type": "object", + "properties": {} + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "deviceOSTypes": { + "type": "array" + } + } + } + } + } + } + } + } + }, + "put": { + "summary": "Updates a device template", + "description": "Updates a new device template in pronghorn", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateDeviceTemplate", + "responses": { + "200": { + "description": "Result of creating a new device template", + "content": { + "application/json": { + "schema": { + "title": "data", + "properties": { + "status": { + "type": "string", + "example": "success" + }, + "updated": { + "type": "number", + "example": 2 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "data": { + "title": "data", + "properties": { + "template": { + "type": "string", + "example": "ntp server {{ ipAddress }}" + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + }, + "name": { + "type": "string", + "example": "NTP Server Template" + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "deviceOSTypes": { + "type": "array" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete one or more device template(s) by Id", + "description": "This API call will delete device templates based on given Ids", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDeviceTemplates", + "responses": { + "200": { + "description": "Status with the number of device templates deleted", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "deleted": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "templateIds": { + "title": "templateIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/templates/search": { + "post": { + "summary": "Gets a device template", + "description": "Gets a new device template in pronghorn", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDeviceTemplates", + "responses": { + "200": { + "description": "Result of creating a new device template", + "content": { + "application/json": { + "schema": { + "title": "data", + "properties": { + "total": { + "type": "number", + "example": 1 + }, + "list": { + "type": "object", + "example": [ + { + "id": "610315295595a5fcb99f8ce2", + "name": "Cisco Login Banner", + "template": "banner login {{ bannerBody }}", + "variables": { + "bannerBody": "Welcome to this Cisco Device." + }, + "created": "2021-07-29T20:52:57.378Z", + "updated": "2021-07-29T20:52:57.378Z", + "createdBy": "5eaaf3796b16027c8aeb612a", + "updatedBy": "5eaaf3796b16027c8aeb612a", + "gbac": { + "write": [], + "read": [] + } + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/import/templates": { + "post": { + "summary": "Import device config template documents", + "description": "Insert device config template documents into the device_templates collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importDeviceTemplates", + "responses": { + "200": { + "description": "Status of template import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 device template imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "templates": { + "title": "templates", + "type": "array", + "items": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/{deviceName}/configuration": { + "post": { + "summary": "Apply a device config", + "description": "This API call will apply a configuration to a specified device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.applyDeviceConfig", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/templates/apply": { + "post": { + "summary": "Apply a device config template", + "description": "This API call will apply a configuration template to a specified device", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.applyDeviceTemplate", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "templateId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/{deviceName}/operationaldata": { + "post": { + "summary": "Get operational data for a device", + "description": "Gets all the operational data for the specified device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.getOperationalData", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "filter": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/import/plans": { + "post": { + "summary": "Import compliance plan documents", + "description": "Insert compliance plan documents into the ucm_compliance_plans collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importCompliancePlan", + "responses": { + "200": { + "description": "Status of compliance plan import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 compliance plan(s) imported successfully." + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "plans": { + "title": "plans", + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "description": "The ID of the compliance plan." + }, + "name": { + "type": "string", + "description": "The name of the compliance plan to import" + }, + "description": { + "type": "string", + "description": "The description of the compliance plan to import" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "treeId": { + "type": "string", + "description": "The treeId of the GC that the node belongs to." + }, + "version": { + "type": "string", + "description": "The version of the GC tree that the node belongs to." + }, + "nodeId": { + "type": "string", + "description": "The configId of the node." + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + } + } + } + }, + "gbac": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plans": { + "post": { + "summary": "Creates a compliance plan", + "description": "Creates a compliance plan which can be used to execute compliance reports", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createCompliancePlan", + "responses": { + "200": { + "description": "Details of the newly created compliance plan", + "content": { + "application/json": { + "schema": { + "title": "compliancePlan", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["Firewall Policies"] + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the compliance plan.", + "examples": ["A compliance plan for firewall configs."] + }, + "nodes": { + "type": "array", + "description": "Nodes to add into the compliance plan.", + "items": { + "type": "object", + "properties": { + "treeId": { + "type": "string", + "description": "The treeId of the GC that the node belongs to." + }, + "version": { + "type": "string", + "description": "The version of the GC tree that the node belongs to." + }, + "nodeId": { + "type": "string", + "description": "The configId of the node." + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "deviceGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "tasks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "put": { + "summary": "Updates a compliance plan", + "description": "Updates a compliance plan that already exists", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateCompliancePlan", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Compliance Plan updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the compliance plan.", + "examples": ["A compliance plan for firewall configs."] + }, + "name": { + "type": "string", + "description": "New name for the Compliance Plan", + "examples": ["Firewall Policies"] + }, + "nodes": { + "type": "array", + "description": "Nodes to add into the compliance plan.", + "items": { + "type": "object", + "properties": { + "treeId": { + "type": "string", + "description": "The treeId of the GC that the node belongs to." + }, + "version": { + "type": "string", + "description": "The version of the GC tree that the node belongs to." + }, + "nodeId": { + "type": "string", + "description": "The configId of the node." + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "deviceGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "tasks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + }, + "gbac": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete compliance plans", + "description": "Delete the specified compliance plans", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteCompliancePlans", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "title": "deleteResult", + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "deleted": { + "type": "number" + } + }, + "required": ["status", "deleted"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planIds": { + "title": "planIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plans/{planId}": { + "get": { + "summary": "Fetches a compliance plan", + "description": "Fetches a compliance plan with the provided ID", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "planId", + "in": "path", + "description": "planId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getCompliancePlan", + "responses": { + "200": { + "description": "Requested Golden Config tree version", + "content": { + "application/json": { + "schema": { + "title": "compliancePlan", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/search/compliance_plans": { + "post": { + "summary": "Search all Compliance Plans", + "description": "Gets a list of all Compliance Plans that match the search criteria", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchCompliancePlans", + "responses": { + "200": { + "description": "List of Compliance Plans that match the search criteria", + "content": { + "application/json": { + "schema": { + "title": "compliancePlans", + "type": "object", + "properties": { + "totalCount": { + "type": "number" + }, + "groups": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "start": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "limit": { + "type": "integer", + "minimum": 1, + "examples": [20] + }, + "sort": { + "type": "number", + "example": 1 + } + }, + "required": ["start", "limit"] + } + } + } + } + } + } + } + }, + "/configuration_manager/search/compliance_plan_instances": { + "post": { + "summary": "Search all Compliance Plan instances", + "description": "Gets a list of all Compliance Plan Instances that match the search criteria", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchCompliancePlanInstances", + "responses": { + "200": { + "description": "List of Compliance Plan Instances that match the search criteria", + "content": { + "application/json": { + "schema": { + "title": "compliancePlanInstances", + "type": "object", + "properties": { + "totalCount": { + "type": "number" + }, + "groups": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "searchParams": { + "title": "searchParams", + "type": "object", + "properties": { + "instanceId": { + "type": "string", + "description": "ID of the instance to fetch" + }, + "planId": { + "type": "string", + "description": "Fetches all instances with this planId" + }, + "planName": { + "type": "string", + "description": "Fetches all instances with this planName" + }, + "description": { + "type": "string", + "description": "Filter by description of the plan instance.", + "example": ["A description for my compliance plan."] + }, + "status": { + "type": "string", + "description": "Filter by status of the Job pertainig to the plan instance.", + "enum": [ + "running", + "complete", + "paused", + "error", + "canceled" + ] + }, + "dateRange": { + "type": "array", + "description": "An array containing the start and end date. Index 0 = start date, index 1 = end date.", + "items": {} + }, + "start": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "limit": { + "type": "integer", + "minimum": 1, + "examples": [20] + }, + "sort": { + "type": "object", + "properties": { + "started": { + "enum": [-1, 1] + }, + "jobStatus": { + "enum": [-1, 1] + }, + "name": { + "enum": [-1, 1] + } + } + } + }, + "oneOf": [ + { + "required": ["instanceId"] + }, + { + "required": ["planId"] + }, + { + "required": ["planName"] + } + ] + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plans/nodes": { + "post": { + "summary": "Adds node(s) to a compliance plan", + "description": "Adds new node(s) to an already existing compliance plan", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.addNodesToCompliancePlan", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": [ + "Successfully added node(s) to compliance plan" + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "nodes": { + "title": "nodes", + "type": "array", + "items": { + "type": "object", + "properties": { + "treeId": { + "type": "string", + "description": "The treeId of the GC that the node belongs to." + }, + "version": { + "type": "string", + "description": "The version of the GC tree that the node belongs to." + }, + "nodeId": { + "type": "string", + "description": "The configId of the node." + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "deviceGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "tasks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + }, + "delete": { + "summary": "Removes node(s) from a compliance plan", + "description": "Removes new node(s) from an already existing compliance plan", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.removeNodesFromCompliancePlan", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": [ + "Successfully added node(s) to compliance plan" + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "nodeIds": { + "title": "nodeIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plans/run": { + "post": { + "summary": "Runs a compliance plan", + "description": "This API call will create WF job that will execute the compliance plan", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runCompliancePlan", + "responses": { + "200": { + "description": "The details of the plan instance that was created.", + "content": { + "application/json": { + "schema": { + "title": "response", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plan_instances": { + "put": { + "summary": "Update properties of a compliance plan instance", + "description": "Update properties of the specified compliance plan instance", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateCompliancePlanInstance", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Compliance Run Report updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "instanceId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "type": "string", + "examples": ["Compliance plan instance description"] + } + } + } + } + } + } + } + } + } + }, + "/automation-studio/templates": { + "get": { + "summary": "Gets a page of template documents.", + "description": "Gets a page of template documents.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + } + }, + { + "name": "exclude-project-members", + "in": "query", + "description": "Flag which removes workflows from the results which are members of a project", + "required": false, + "schema": { + "type": "boolean", + "description": "Flag which removes workflows from the results which are members of a project" + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "in", + "in": "query", + "description": "Search for fields exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "not-in", + "in": "query", + "description": "Search for fields not exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "equals", + "in": "query", + "description": "Returns results where the specified fields exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string" + } + }, + { + "name": "contains", + "in": "query", + "description": "Returns results where the specified fields contain the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields contain the given match string(s).", + "type": "string" + } + }, + { + "name": "starts-with", + "in": "query", + "description": "Returns results where the specified fields start with the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string" + } + }, + { + "name": "ends-with", + "in": "query", + "description": "Returns results where the specified fields end in the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.getTemplates", + "responses": { + "200": { + "description": "Results for the given search parameters.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_template" + } + }, + "total": { + "type": "integer", + "description": "Total number of documents matching the given query parameters." + }, + "start": { + "type": "integer", + "description": "Search index of first document in the items array." + }, + "end": { + "type": "integer", + "description": "Search index of the last document in the items array." + }, + "count": { + "type": "integer", + "description": "Length of the items array." + }, + "next": { + "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "previous": { + "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Creates a new template document.", + "description": "Creates a new template document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.createTemplate", + "responses": { + "200": { + "description": "Created template and associated edit URI.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "description": "Created template and associated edit URI.", + "properties": { + "created": { + "$ref": "#/components/schemas/automation-studio_template" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the newly created template." + } + }, + "required": ["created", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "$ref": "#/components/schemas/automation-studio_template" + } + } + } + } + } + } + } + }, + "/automation-studio/templates/{id}": { + "get": { + "summary": "Gets a single template document.", + "description": "Gets a single template document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ObjectId specifying a template entity.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "ObjectId specifying a template entity." + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + } + ], + "operationId": "AutomationStudio.getTemplate", + "responses": { + "200": { + "description": "Transformed data.", + "content": { + "application/json": { + "schema": { + "title": "output", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Deletes a template document.", + "description": "Deletes a template document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Template id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Template id." + } + } + ], + "operationId": "AutomationStudio.deleteTemplate", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Message denoting the status of the delete operation." + } + }, + "required": ["message"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Replaces a template document.", + "description": "Replaces a template document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Template id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Template id." + } + } + ], + "operationId": "AutomationStudio.updateTemplate", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "updated": { + "$ref": "#/components/schemas/automation-studio_template" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the updated template." + } + }, + "required": ["updated", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "update": { + "$ref": "#/components/schemas/automation-studio_templateUpdate" + } + } + } + } + } + } + } + }, + "/automation-studio/templates/import": { + "post": { + "summary": "Imports a new template document.", + "description": "Imports a new template document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.importTemplates", + "responses": { + "200": { + "description": "Results from each individual import operation.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "imported": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Status flag denoting the success (true) or failure (false) of the template's import operation." + }, + "message": { + "type": "string", + "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." + }, + "original": { + "$ref": "#/components/schemas/automation-studio_templateImport" + }, + "created": { + "description": "The imported template as it exists after being imported.", + "oneOf": [ + { + "$ref": "#/components/schemas/automation-studio_template" + }, + { + "type": "null" + } + ] + }, + "edit": { + "description": "URI to the edit page for the imported template.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "message", + "original", + "created", + "edit" + ] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "templates": { + "title": "templates", + "description": "Array of template documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a template's name is already used in the templates collection, it will be renamed with a numeric suffix.", + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_templateImport" + } + } + } + } + } + } + } + } + }, + "/automation-studio/templates/{id}/export": { + "get": { + "summary": "Exports a template document.", + "description": "Exports a template document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Template id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Template id." + } + } + ], + "operationId": "AutomationStudio.exportTemplate", + "responses": { + "200": { + "description": "Exported representation of the template.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_templateImport" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/json-forms/method-options": { + "get": { + "summary": "Get all available rest calls in IAP.", + "description": "Get all available rest calls in IAP.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.getMethodOptions", + "responses": { + "200": { + "description": "List of all rest calls available in the system.", + "content": { + "application/json": { + "schema": { + "title": "calls", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "getTemplate", + "createTemplate", + "importTemplates", + "exportTemplate" + ] + }, + "sourceType": { + "type": "string", + "examples": [ + "AutomationStudio", + "ConfigurationManager", + "MOP" + ] + }, + "path": { + "type": "string", + "examples": [ + "/templates/:id", + "/createTemplate", + "/listAnalyticTemplates" + ] + }, + "verb": { + "type": "string", + "enum": ["GET", "POST"] + }, + "origin": { + "type": "string", + "examples": [ + "/automation-studio", + "/mop", + "/validate-form/:id" + ] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AutomationStudio.admin"], + "CookieAuth": ["AutomationStudio.admin"], + "BasicAuth": ["AutomationStudio.admin"] + } + ], + "deprecated": false + } + }, + "/automation-studio/apps/list": { + "get": { + "summary": "Get a list of all the apps and adapters", + "description": "Get all apps and adapters.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.getAppsAndAdapters", + "responses": { + "200": { + "description": "List of all apps and adapters.", + "content": { + "application/json": { + "schema": { + "title": "apps_list", + "type": "array", + "items": { + "type": "object", + "examples": [ + { + "id": "@itential/app-admin_essentials", + "type": "UI", + "name": "AdminEssentials" + }, + { + "id": "@itential/app-automation_studio", + "type": "Application", + "name": "AutomationStudio" + }, + { + "id": "@itential/app-configuration_manager", + "type": "Application", + "name": "ConfigurationManager" + }, + { + "id": "@itential/app-ag_manager", + "type": "Application", + "name": "AGManager" + }, + { + "id": "@itential/app-form_builder", + "type": "Application", + "name": "FormBuilder" + } + ] + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/workflows": { + "get": { + "summary": "Gets a page of workflow documents.", + "description": "Gets a page of workflow documents.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + } + }, + { + "name": "exclude-project-members", + "in": "query", + "description": "Flag which removes workflows from the results which are members of a project", + "required": false, + "schema": { + "type": "boolean", + "description": "Flag which removes workflows from the results which are members of a project" + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "expand", + "in": "query", + "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", + "required": false, + "schema": { + "type": "string", + "title": "List of fields to get expanded data", + "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", + "examples": ["created_by,user,owner"] + } + }, + { + "name": "in", + "in": "query", + "description": "Search for fields exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string", + "examples": [ + "in[name]=my-workflow,or-this-workflow&in[type]=automation" + ] + } + }, + { + "name": "not-in", + "in": "query", + "description": "Search for fields not exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string", + "examples": ["not-in[name]=my-workflow,not-this-workflow"] + } + }, + { + "name": "equals", + "in": "query", + "description": "Returns results where the specified fields exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string", + "examples": ["equals[name]=my-workflow"] + } + }, + { + "name": "contains", + "in": "query", + "description": "Returns results where the specified fields contain the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields contain the given match string(s).", + "type": "string", + "examples": ["contains[name]=workflow"] + } + }, + { + "name": "starts-with", + "in": "query", + "description": "Returns results where the specified fields start with the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string", + "examples": ["starts-with[name]=my-"] + } + }, + { + "name": "ends-with", + "in": "query", + "description": "Returns results where the specified fields end in the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string", + "examples": ["ends-with[name]=-workflow"] + } + }, + { + "name": "task-equals", + "in": "query", + "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", + "type": "string", + "examples": ["task-equals[app]=WorkFlowEngine"] + } + } + ], + "operationId": "AutomationStudio.getWorkflows", + "responses": { + "200": { + "description": "Results for the given search parameters.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_workflowDocument" + } + }, + "total": { + "type": "integer", + "description": "Total number of documents matching the given query parameters." + }, + "start": { + "type": "integer", + "description": "Search index of first document in the items array." + }, + "end": { + "type": "integer", + "description": "Search index of the last document in the items array." + }, + "count": { + "type": "integer", + "description": "Length of the items array." + }, + "limit": { + "type": "integer", + "description": "Number of results to return. Used for pagination." + }, + "next": { + "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "previous": { + "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/workflows/detailed/{name}": { + "get": { + "summary": "Get Details of a Workflow", + "description": "Get the details of a Workflow by Workflow name.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow to get Workflow details.", + "required": true, + "schema": { + "type": "string", + "title": "name" + } + } + ], + "operationId": "AutomationStudio.getWorkflowDetailedByName", + "responses": { + "200": { + "description": "Workflow details matching the Workflow name.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_workflowDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/automations": { + "post": { + "summary": "Creates a new workflow document.", + "description": "Creates a new workflow document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.createAutomation", + "responses": { + "200": { + "description": "Created workflow and associated edit URI.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "description": "Created workflow and associated edit URI.", + "properties": { + "created": { + "$ref": "#/components/schemas/automation-studio_automation" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the newly created workflow." + } + }, + "required": ["created", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "automation": { + "$ref": "#/components/schemas/automation-studio_automation" + } + } + } + } + } + } + } + }, + "/automation-studio/automations/{id}": { + "put": { + "summary": "Replaces a workflow document.", + "description": "Replaces a workflow document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Workflow id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Workflow id." + } + } + ], + "operationId": "AutomationStudio.updateAutomation", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "updated": { + "$ref": "#/components/schemas/automation-studio_automation" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the updated workflow." + } + }, + "required": ["updated", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "update": { + "$ref": "#/components/schemas/automation-studio_automationUpdate" + } + } + } + } + } + } + } + }, + "/automation-studio/automations/import": { + "post": { + "summary": "Imports a new workflow document.", + "description": "Imports a new workflow document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.importAutomations", + "responses": { + "200": { + "description": "Results from each individual import operation.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "imported": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Status flag denoting the success (true) or failure (false) of the workflow's import operation." + }, + "message": { + "type": "string", + "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." + }, + "original": { + "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" + }, + "created": { + "description": "The imported workflow as it exists after being imported.", + "oneOf": [ + { + "$ref": "#/components/schemas/automation-studio_workflowDocument" + }, + { + "type": "null" + } + ] + }, + "edit": { + "description": "URI to the edit page for the imported workflow.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "message", + "original", + "created", + "edit" + ] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "automations": { + "title": "automations", + "description": "Array of workflow documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'.", + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" + } + } + } + } + } + } + } + } + }, + "/automation-studio/component-groups": { + "get": { + "summary": "Gets a page of component group documents.", + "description": "Gets a page of component group documents.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "in", + "in": "query", + "description": "Search for fields exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "not-in", + "in": "query", + "description": "Search for fields not exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "equals", + "in": "query", + "description": "Returns results where the specified fields exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string" + } + }, + { + "name": "contains", + "in": "query", + "description": "Returns results where the specified fields contain the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields contain the given match string(s).", + "type": "string" + } + }, + { + "name": "starts-with", + "in": "query", + "description": "Returns results where the specified fields start with the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string" + } + }, + { + "name": "ends-with", + "in": "query", + "description": "Returns results where the specified fields end in the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.getComponentGroups", + "responses": { + "200": { + "description": "Results for the given search parameters.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_componentGroup" + } + }, + "total": { + "type": "integer", + "description": "Total number of documents matching the given query parameters.", + "examples": [100] + }, + "start": { + "type": "integer", + "description": "Search index of first document in the items array.", + "examples": [0] + }, + "end": { + "type": "integer", + "description": "Search index of the last document in the items array.", + "examples": [100] + }, + "count": { + "type": "integer", + "description": "Length of the items array.", + "examples": [100] + }, + "next": { + "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "previous": { + "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Creates a new component group document.", + "description": "Creates a new component group document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.createComponentGroup", + "responses": { + "200": { + "description": "Created component group and associated edit URI.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "description": "Created component group and associated edit URI.", + "properties": { + "created": { + "$ref": "#/components/schemas/automation-studio_componentGroup" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the newly created component group." + } + }, + "required": ["created", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "componentGroup": { + "$ref": "#/components/schemas/automation-studio_componentGroup" + } + } + } + } + } + } + } + }, + "/automation-studio/component-groups/{id}": { + "get": { + "summary": "Gets a single component group document.", + "description": "Gets a single component group document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ObjectId specifying a component group entity.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "ObjectId specifying a component group entity." + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + } + ], + "operationId": "AutomationStudio.getComponentGroup", + "responses": { + "200": { + "description": "Transformed data.", + "content": { + "application/json": { + "schema": { + "title": "output", + "type": "object", + "examples": [ + { + "_id": "67d863a07620432ed58f7964", + "name": "Automation Studio", + "description": "", + "gbacRead": [], + "gbacWrite": [], + "members": [ + { + "path": ["addComponentsToProject"], + "ref": "2c27f941-aa37-42b2-9ecf-d0398676745d", + "sourceCollection": "workflows", + "type": "component", + "name": "addComponentsToProject" + }, + { + "path": ["createProject"], + "ref": "887d1e2d-3641-41f4-9f93-40bc0f134b5b", + "sourceCollection": "workflows", + "type": "component", + "name": "createProject" + } + ] + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Deletes a component group document.", + "description": "Deletes a component group document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Component group id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Component group id." + } + } + ], + "operationId": "AutomationStudio.deleteComponentGroup", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Message denoting the status of the delete operation.", + "examples": [ + "Deleted componentGroup 67d32e60a402649caa29a006" + ] + } + }, + "required": ["message"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Replaces a component group document.", + "description": "Replaces a component group document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Component group id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Component group id." + } + } + ], + "operationId": "AutomationStudio.updateComponentGroup", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "updated": { + "$ref": "#/components/schemas/automation-studio_componentGroup" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the updated component group." + } + }, + "required": ["updated", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "update": { + "$ref": "#/components/schemas/automation-studio_componentGroupUpdate" + } + } + } + } + } + } + } + }, + "/automation-studio/component-groups/import": { + "post": { + "summary": "Imports a new component group document.", + "description": "Imports a new component group document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.importComponentGroups", + "responses": { + "200": { + "description": "Results from each individual import operation.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "imported": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Status flag denoting the success (true) or failure (false) of the component group's import operation." + }, + "message": { + "type": "string", + "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." + }, + "original": { + "$ref": "#/components/schemas/automation-studio_componentGroupImport" + }, + "created": { + "description": "The imported component group as it exists after being imported.", + "oneOf": [ + { + "$ref": "#/components/schemas/automation-studio_componentGroup" + }, + { + "type": "null" + } + ] + }, + "edit": { + "description": "URI to the edit page for the imported component group.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "message", + "original", + "created", + "edit" + ] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "componentGroups": { + "title": "componentGroups", + "description": "Array of component group documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a component group's name is already used in the component groups collection, it will be renamed with a numeric suffix.", + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_componentGroupImport" + } + } + } + } + } + } + } + } + }, + "/automation-studio/workflows/validate": { + "post": { + "summary": "Validate a workflow", + "description": "Validate a workflow, and return the resulting errors and warnings arrays.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.validateWorkflow", + "responses": { + "200": { + "description": "Errors and warnings output from the validation process", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "validationResult", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "object" + } + }, + "warnings": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread", + "AutomationStudio.apiwrite" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread", + "AutomationStudio.apiwrite" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread", + "AutomationStudio.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" + } + } + } + } + } + } + } + }, + "/automation-studio/references-to": { + "get": { + "summary": "Gets references to a particular document.", + "description": "Gets references to a particular document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "target-type", + "in": "query", + "description": "Type of document to search for references to.", + "required": false, + "schema": { + "type": "string", + "description": "Type of document to search for references to." + } + }, + { + "name": "target-identifiers", + "in": "query", + "description": "IDs of the components to search for references to.", + "required": false, + "schema": { + "type": "string", + "description": "IDs of the components to search for references to." + } + }, + { + "name": "referrer-type", + "in": "query", + "description": "Type of documents to search for references in.", + "required": false, + "schema": { + "type": "string", + "description": "Type of documents to search for references in." + } + } + ], + "operationId": "AutomationStudio.getReferencesTo", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "referencesByTarget": { + "type": "array", + "items": { + "type": "object", + "properties": { + "target": { + "type": "object", + "properties": { + "identifer": { + "type": "string", + "examples": [ + "940a1b4f-399a-44df-a42e-d37da51c7637", + "5eb596edf955d0e5288f84ef" + ] + }, + "type": { + "type": "string", + "enum": [ + "workflow", + "json-form", + "transformation", + "template", + "command-template", + "analytic-template", + "form" + ] + } + } + }, + "totalReferencingInstances": { + "type": "number" + }, + "totalReferences": { + "type": "number" + }, + "references": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "workflow", + "json-form", + "transformation", + "template", + "command-template", + "analytic-template", + "form" + ] + }, + "_id": { + "type": "string", + "examples": [ + "940a1b4f-399a-44df-a42e-d37da51c7637", + "5eb596edf955d0e5288f84ef" + ] + }, + "name": { + "type": "string" + }, + "referencePaths": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": true + } + }, + "/automation-studio/locations/{location}/packages/{pckg}/tasks/{method}": { + "get": { + "summary": "Get Task Details", + "description": "Get the detailed information model for a task", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "location", + "in": "path", + "description": "Location: Application, Broker, Adapter", + "required": true, + "schema": { + "type": "string", + "title": "location" + } + }, + { + "name": "pckg", + "in": "path", + "description": "Package name", + "required": true, + "schema": { + "type": "string", + "title": "pckg", + "examples": ["WorkFlowEngine"] + } + }, + { + "name": "method", + "in": "path", + "description": "Method name", + "required": true, + "schema": { + "type": "string", + "title": "method", + "examples": ["query", "merge"] + } + } + ], + "operationId": "AutomationStudio.getTaskDetails", + "responses": { + "200": { + "description": "Detailed information on a task", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_taskDetails" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] + } + ], + "deprecated": false + } + }, + "/automation-studio/multipleTaskDetails": { + "post": { + "summary": "Get Task Details", + "description": "Get the detailed information model for a task", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.getMultipleTaskDetails", + "responses": { + "200": { + "description": "Detailed information on a task", + "content": { + "application/json": { + "schema": { + "type": "array", + "title": "taskDetails", + "items": { + "$ref": "#/components/schemas/automation-studio_taskDetails" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "inputsArray": { + "type": "array", + "title": "inputsArray", + "items": { + "type": "object", + "properties": { + "location": { + "title": "location", + "type": "string", + "description": "Location: Application, Broker, Adapter", + "examples": ["Application", "Adapter", "Broker"] + }, + "pckg": { + "title": "pckg", + "type": "string", + "description": "Package name", + "examples": ["WorkFlowEngine"] + }, + "method": { + "title": "method", + "type": "string", + "description": "Method name", + "examples": ["query", "merge"] + } + } + } + } + } + } + } + } + } + } + }, + "/automation-studio/projects": { + "get": { + "summary": "Search projects", + "description": "Search projects", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.getProjects", + "responses": { + "200": { + "description": "Projects", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully retrieved projects"] + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + }, + "metadata": { + "type": "object", + "properties": { + "skip": { + "type": "number" + }, + "limit": { + "type": "number" + }, + "total": { + "type": "number" + }, + "previousPageSkip": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "number" + } + ] + }, + "nextPageSkip": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "number" + } + ] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Creates a new project", + "description": "Creates a new project", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.createProject", + "responses": { + "200": { + "description": "Create result", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully created project"] + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "createData", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_projects-create-data" + } + } + } + } + } + }, + "/automation-studio/projects/{projectId}": { + "get": { + "summary": "Gets a single Project", + "description": "Gets a single Project", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.getProject", + "responses": { + "200": { + "description": "API response body", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully retrieved project"] + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Updates an existing project", + "description": "Updates an existing project", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier, either an ObjectId or an IID", + "required": true, + "schema": { + "$ref": "#/components/schemas/automation-studio_projects-http-id" + } + } + ], + "operationId": "AutomationStudio.updateProject", + "responses": { + "200": { + "description": "Update result", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "updateData", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_projects-update-data" + } + } + } + } + } + }, + "/automation-studio/projects/{id}/export": { + "get": { + "summary": "Exports a project document as a JSON document, inlining all related documents into its components array", + "description": "Exports a project document as a JSON document, inlining all related documents into its components array", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.exportProject", + "responses": { + "200": { + "description": "Exported project", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully exported project"] + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-export-v1" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/projects/import": { + "post": { + "summary": "Imports a project document from a JSON document", + "description": "Imports a project document from a JSON document", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.importProject", + "responses": { + "200": { + "description": "Import result", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "properties": { + "project": { + "$ref": "#/components/schemas/automation-studio_projects-export-v1" + }, + "conflictMode": { + "type": "string", + "enum": ["overwrite", "insert-new"] + }, + "skipReferenceValidation": { + "type": "boolean", + "description": "If true, validations will not be run against references.", + "default": false + }, + "assignNewReferences": { + "type": "boolean", + "description": "This being true would indicate that the imported project is part of a clone action.", + "default": false + } + } + } + } + } + } + } + }, + "/automation-studio/discoverReferences": { + "post": { + "summary": "Discover referenced resources", + "description": "Finds all resource references from a set of specified resource identifiers", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.discoverReferences", + "responses": { + "200": { + "description": "References", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_resource-ref-http" + } + } + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer", + "AutomationStudio.engineering" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer", + "AutomationStudio.engineering" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer", + "AutomationStudio.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "properties": { + "resourceIdentifiers": { + "type": "array", + "description": "Array of resource identifiers to find references for.", + "items": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of the resource." + }, + "resourcePointer": { + "type": "string", + "description": "The pointer to the identifier value in the resource object." + }, + "resourceId": { + "type": "string", + "description": "The value of the identifier in the resource object." + }, + "recursionDepth": { + "type": "integer", + "description": "Specifies the number of hierarchical levels to traverse when discovering references for this component. If omitted, the search on this component will be fully recursive." + } + } + } + }, + "recursive": { + "type": "boolean", + "description": "If true, recursively looks up resources on all referenced resources.", + "default": false + }, + "includeResources": { + "type": "boolean", + "description": "If true, include the full resource document in each resource reference object.", + "default": false + }, + "ignore": { + "type": "object", + "description": "An object of resource types to directions that will not be included in discovery. Cannot be used with include.", + "additionalProperties": { + "enum": ["up", "down", "all"] + } + }, + "include": { + "type": "object", + "description": "An object of resource types and directions to be included in discovery. Cannot be used with ignore.", + "additionalProperties": { + "enum": ["up", "down", "all"] + } + }, + "removeCycles": { + "type": "boolean", + "description": "If true, removes all cyclic relationships from the list of resource references.", + "default": false + } + } + } + } + } + } + } + }, + "/automation-studio/projects/{id}": { + "delete": { + "summary": "Delete a project and any components it contains", + "description": "Delete a project and any components it contains", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Project ID", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Project ID" + } + } + ], + "operationId": "AutomationStudio.deleteProject", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Message denoting the status of the delete operation." + } + }, + "required": ["message"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/projects/{projectId}/components/{componentId}": { + "delete": { + "summary": "Remove a component from a project", + "description": "Remove a component from a project", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string", + "description": "Project identifier" + } + }, + { + "name": "componentId", + "in": "path", + "description": "Component identifier", + "required": true, + "schema": { + "title": "componentId", + "type": "number", + "description": "Component identifier" + } + } + ], + "operationId": "AutomationStudio.removeComponentFromProject", + "responses": { + "200": { + "description": "Response object", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Message denoting the status of the delete operation" + }, + "data": { + "$ref": "#/components/schemas/automation-studio_projects-http" + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "description": "Options designating removal mode", + "properties": { + "mode": { + "type": "string", + "enum": ["delete", "move"] + } + } + } + } + } + } + } + } + } + }, + "/automation-studio/projects/{projectId}/components/add": { + "post": { + "summary": "Add one or more components to Project", + "description": "Add one or more components to Project", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.addComponentsToProject", + "responses": { + "200": { + "description": "Updated project", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + }, + "metadata": { + "type": "object", + "properties": { + "newComponents": { + "type": "array", + "description": "Components added" + }, + "failedComponents": { + "type": "array", + "description": "Components failed to add" + }, + "idMap": { + "type": "array", + "description": "Id map for original and cloned component", + "examples": [ + [ + { + "original": "1a643151-459b-4a4a-be91-623536b65df3", + "clone": "8696f332-030b-4c2a-8b1b-95844cbb6aea" + } + ] + ] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "required": ["components"], + "properties": { + "components": { + "$ref": "#/components/schemas/automation-studio_projects-common_components" + }, + "mode": { + "type": "string", + "enum": ["move", "copy"] + } + } + } + } + } + } + } + }, + "/automation-studio/projects/{projectId}/thumbnail": { + "put": { + "summary": "Set a project's thumbnail image", + "description": "Set a project's thumbnail image", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.uploadProjectThumbnail", + "responses": { + "200": { + "description": "Updated project", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_project-thumbnails-update-data" + } + } + } + } + }, + "get": { + "summary": "Gets a Project's thumbnail", + "description": "Gets a Project's thumbnail. Returns data as a base64 encoded string of binary data.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.getProjectThumbnail", + "responses": { + "200": { + "description": "API response body", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully retrieved project thumbnail"] + }, + "data": { + "type": "object", + "properties": { + "image": { + "description": "Base64 encoded binary contents of the image file", + "type": "string", + "examples": [""] + }, + "backgroundColor": { + "description": "Hex value of thumbnail background color", + "type": "string", + "examples": ["#FFFFFF"] + }, + "metadata": { + "type": "object" + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] + } + ], + "deprecated": false + } + }, + "/tags/get": { + "post": { + "summary": "Get tag details given an id", + "description": "Get details and results for a single tag given that tags id.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.get", + "responses": { + "200": { + "description": "Tag details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "title": "id", + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + } + } + } + } + } + } + } + }, + "/tags/find": { + "post": { + "summary": "Find tags by name", + "description": "Find a list of tags given a name.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.find", + "responses": { + "200": { + "description": "Tag details", + "content": { + "application/json": { + "schema": { + "title": "details", + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/tags/all": { + "get": { + "summary": "Get all tags", + "description": "Get a list of all tags.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.all", + "responses": { + "200": { + "description": "Get all tags", + "content": { + "application/json": { + "schema": { + "title": "details", + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false + } + }, + "/tags/create": { + "post": { + "summary": "Create new tag", + "description": "Create a new tag.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.create", + "responses": { + "200": { + "description": "New tag data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/tags_tagDocument_tagName" + }, + "description": { + "$ref": "#/components/schemas/tags_tagDocument_tagDescription" + } + } + } + } + } + } + } + } + } + }, + "/tags/createTags": { + "post": { + "summary": "Create many new tags", + "description": "Create multiple new tags at once.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.createTags", + "responses": { + "200": { + "description": "New tag data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/tags_tagDocument_tagName" + }, + "description": { + "$ref": "#/components/schemas/tags_tagDocument_tagDescription" + } + } + } + } + } + } + } + } + } + } + }, + "/tags/createReference": { + "post": { + "summary": "Reference a tag to a peice of content", + "description": "Create reference for tag that links it to a peice of content. This allows for content to find the tags related to it.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.createReference", + "responses": { + "200": { + "description": "New Reference Tag data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_referenceObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], + "CookieAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], + "BasicAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "tag_id": { + "$ref": "#/components/schemas/tags_tagDocument_tagId" + }, + "ref_id": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefId" + }, + "type": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefType" + } + } + } + } + } + } + } + } + } + }, + "/tags/handleReferences": { + "post": { + "summary": "Create/Update references for tags", + "description": "Create/Update references for multiple tags to a peice of content", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.handleReferences", + "responses": { + "200": { + "description": "If tag reference updates were successful.", + "content": { + "application/json": { + "schema": { + "title": "success", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], + "CookieAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], + "BasicAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "tag_ids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_tagId" + } + }, + "ref_id": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefId" + }, + "type": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefType" + } + } + } + } + } + } + } + } + } + }, + "/tags/getTagsByReference": { + "post": { + "summary": "Get Tags by content id", + "description": "Get tags for a piece of content by the content id", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.getTagsByReference", + "responses": { + "200": { + "description": "Array of tags related to reference id", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_referenceObject" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], + "CookieAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], + "BasicAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "ref_id": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefId" + } + } + } + } + } + } + } + } + } + }, + "/tags/getTagReferences": { + "post": { + "summary": "Get Tag refs by content ids", + "description": "Get tag references from multiple content ids.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.getTagReferences", + "responses": { + "200": { + "description": "Array of tags related to content ids", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_referenceObject" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], + "CookieAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], + "BasicAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "ref_id": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefId" + } + } + } + } + } + } + } + } + } + } + }, + "/tags/update": { + "post": { + "summary": "Updating existing tag", + "description": "Updating existing tag", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.update", + "responses": { + "200": { + "description": "Updated tag data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag": { + "type": "object", + "title": "tag", + "properties": { + "_id": { + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + }, + "description": { + "type": "string", + "examples": ["Descriptions can be empty"] + }, + "name": { + "type": "string", + "examples": ["My Tag"] + } + } + } + } + } + } + } + } + } + }, + "/tags/duplicate": { + "post": { + "summary": "Clone existing tag", + "description": "Duplicate existing tag by cloning it and changing the name.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.duplicate", + "responses": { + "200": { + "description": "Results from duplicated tag", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_id": { + "title": "_id", + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + } + } + } + } + } + } + } + }, + "/tags/delete": { + "post": { + "summary": "Delete existing tag", + "description": "Delete an existing tag.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.delete", + "responses": { + "200": { + "description": "Results from deleted tag", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_id": { + "title": "_id", + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + } + } + } + } + } + } + } + }, + "/workflow_engine/activate": { + "post": { + "summary": "Activate Task Worker", + "description": "Activate Task Worker", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.activate", + "responses": { + "200": { + "description": "Status flag of activation", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/jobWorker/activate": { + "post": { + "summary": "Activate the job worker", + "description": "Allow new parent jobs to be created", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.activateJobWorker", + "responses": { + "200": { + "description": "Status flag of activation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/deactivate": { + "post": { + "summary": "Deactivate Task Worker", + "description": "Deactivate Task Worker", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.deactivate", + "responses": { + "200": { + "description": "Status flag of deactivation", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/jobWorker/deactivate": { + "post": { + "summary": "Deactivate the job worker", + "description": "Disallow new parent jobs from being created", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.deactivateJobWorker", + "responses": { + "200": { + "description": "Status flag of deactivation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/diffToHTML": { + "post": { + "summary": "diff to HTML", + "description": "Difference between two values in HTML response", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.diffToHTML", + "responses": { + "200": { + "description": "HTML difference between value1 and value2", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string", + "examples": ["config configuration \n 3 222 \n was is "] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "label1": { + "title": "label1", + "type": "string", + "examples": ["pre"] + }, + "value1": { + "title": "value1", + "type": "string", + "examples": [ + "config\n stuff \nline 3 \ntoday was a good day" + ] + }, + "label2": { + "title": "label2", + "type": "string", + "examples": ["post"] + }, + "value2": { + "title": "value2", + "type": "string", + "examples": [ + "configuration\n stuff \nline 222 \ntoday is a good day" + ] + } + } + } + } + } + } + } + }, + "/workflow_engine/jobs/metrics": { + "get": { + "summary": "Get aggregate job metrics", + "description": "Search aggregate job metrics with options", + "tags": ["workflow_engine"], + "parameters": [ + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_order" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_sort" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" + } + }, + { + "name": "greaterThanEquals", + "in": "query", + "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", + "required": false, + "schema": { + "type": "integer", + "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", + "examples": [1617383798468, 1617383798460] + } + }, + { + "name": "greaterThanEqualsField", + "in": "query", + "description": "Date field to compare.", + "required": false, + "schema": { + "type": "string", + "description": "Date field to compare.", + "examples": ["metrics.startDate"], + "enum": ["metrics.startDate"] + } + }, + { + "name": "contains", + "in": "query", + "description": "String value to compare with containsField.", + "required": false, + "schema": { + "type": "string", + "description": "String value to compare with containsField.", + "examples": ["exampleName"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "Field to compare with contains value.", + "required": false, + "schema": { + "type": "string", + "description": "Field to compare with contains value.", + "examples": ["workflow.name"], + "enum": ["workflow.name"] + } + } + ], + "operationId": "WorkFlowEngine.getJobMetrics", + "responses": { + "200": { + "description": "metrics", + "content": { + "application/json": { + "schema": { + "title": "metrics", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow_engine_taskMetricsDocument" + } + }, + "skip": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" + }, + "limit": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" + }, + "total": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/tasks/metrics": { + "get": { + "summary": "Get aggregate task metrics", + "description": "Search aggregate task metrics with options", + "tags": ["workflow_engine"], + "parameters": [ + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_order" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_sort" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" + } + }, + { + "name": "greaterThanEquals", + "in": "query", + "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", + "required": false, + "schema": { + "type": "integer", + "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", + "examples": [1617383798468, 1617383798460] + } + }, + { + "name": "greaterThanEqualsField", + "in": "query", + "description": "Date field to compare.", + "required": false, + "schema": { + "type": "string", + "description": "Date field to compare.", + "examples": ["metrics.startDate"], + "enum": ["metrics.startDate"] + } + }, + { + "name": "equals", + "in": "query", + "description": "String value to compare with equalsField.", + "required": false, + "schema": { + "type": "string", + "description": "String value to compare with equalsField.", + "examples": ["exampleName"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "Field to compare with equals value.", + "required": false, + "schema": { + "type": "string", + "description": "Field to compare with equals value.", + "examples": ["workflow.name"], + "enum": ["workflow.name"] + } + } + ], + "operationId": "WorkFlowEngine.getTaskMetrics", + "responses": { + "200": { + "description": "metrics", + "content": { + "application/json": { + "schema": { + "title": "metrics", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow_engine_jobMetricsDocument" + } + }, + "skip": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" + }, + "limit": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" + }, + "total": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/workers/status": { + "get": { + "summary": "Get the current and future states of the task and job workers", + "description": "Get the current and future states of the task and job workers", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.getWorkerStatuses", + "responses": { + "200": { + "description": "Statuses of the job and task worker", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "jobWorker": { + "type": "object", + "properties": { + "running": { + "type": "boolean", + "description": "Whether the worker is currently running" + }, + "clusterValue": { + "type": "string", + "enum": ["enabled", "disabled", "not defined"], + "description": "Whether the service_config was set to enable this worker" + }, + "localValue": { + "type": "string", + "enum": ["enabled", "disabled", "not defined"], + "description": "Whether the properties.json was set to enable this worker" + }, + "startupValue": { + "type": "boolean", + "description": "Whether the clusterValue and localValue combined allow the worker to start" + } + } + }, + "taskWorker": { + "type": "object", + "properties": { + "running": { + "type": "boolean", + "description": "Whether the worker is currently running" + }, + "clusterValue": { + "type": "string", + "enum": ["enabled", "disabled", "not defined"], + "description": "Whether the service_config was set to enable this worker" + }, + "localValue": { + "type": "string", + "enum": ["enabled", "disabled", "not defined"], + "description": "Whether the properties.json was set to enable this worker" + }, + "startupValue": { + "type": "boolean", + "description": "Whether the clusterValue and localValue combined allow the worker to start" + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/active": { + "get": { + "summary": "Check Staterator State", + "description": "Check if Staterator is currently active", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.isActive", + "responses": { + "200": { + "description": "Active flag for Staterator", + "content": { + "application/json": { + "schema": { + "title": "state", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": true + } + }, + "/workflow_engine/query": { + "post": { + "summary": "Query Data Using 'json-query' Format", + "description": "Query data using a dot/bracket notation string and a matching key/value pair.", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.query", + "responses": { + "200": { + "description": "Returned data from the match query", + "content": { + "application/json": { + "schema": { + "title": "return_data", + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "object" + }, + { + "type": "array" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "examples": ["value"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "job_id": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_mongoObjectId" + }, + "pass_on_null": { + "title": "pass_on_null", + "type": "boolean" + }, + "query": { + "title": "query", + "type": "string", + "examples": ["name"] + }, + "obj": { + "title": "obj", + "type": "object", + "properties": {}, + "examples": [ + { + "name": "value" + } + ] + } + } + } + } + } + } + } + }, + "/workflow_engine/runEvaluationGroup": { + "post": { + "summary": "Evaluation", + "description": "Run a test evaluation.", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.runEvaluationGroup", + "responses": { + "200": { + "description": "Result of evaluation.", + "content": { + "application/json": { + "schema": { + "type": "boolean", + "title": "evaluation_group_value" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "evaluation_group": { + "title": "evaluation_group", + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_evaluationItem" + } + }, + "all_true_flag": { + "title": "all_true_flag", + "type": "boolean" + } + } + } + } + } + } + } + }, + "/workflow_engine/runEvaluationGroups": { + "post": { + "summary": "Evaluation Group", + "description": "Run a test evaluation group.", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.runEvaluationGroups", + "responses": { + "200": { + "description": "Result of evaluation.", + "content": { + "application/json": { + "schema": { + "type": "boolean", + "title": "return_value" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "evaluation_group": { + "title": "evaluation_group", + "type": "array", + "items": { + "type": "object", + "properties": { + "evaluations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_evaluationItem" + } + }, + "all_true_flag": { + "type": "boolean" + } + } + } + }, + "all_true_flag": { + "title": "all_true_flag", + "type": "boolean" + } + } + } + } + } + } + } + }, + "/json-forms/forms": { + "post": { + "summary": "Creates a Json Form", + "description": "Creates a new JSON form document with a unique name.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.createForm", + "responses": { + "200": { + "description": "document that was created from the request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["Device Form"] + }, + "description": { + "title": "description", + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "struct": { + "$ref": "#/components/schemas/json-forms_formStruct" + }, + "schema": { + "$ref": "#/components/schemas/json-forms_formSchema_container" + }, + "uiSchema": { + "$ref": "#/components/schemas/json-forms_formUISchema_container" + }, + "bindingSchema": { + "$ref": "#/components/schemas/json-forms_formBindingSchema_bindingSchema" + }, + "validationSchema": { + "$ref": "#/components/schemas/json-forms_formValidationSchema_validationSchema" + } + } + } + } + } + } + }, + "get": { + "summary": "Returns all forms", + "description": "Returns all JSON form documents that have previously been created.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.getForms", + "responses": { + "200": { + "description": "An array of form documents.", + "content": { + "application/json": { + "schema": { + "title": "forms", + "type": "array", + "items": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + }, + "examples": [ + [ + { + "id": "62bf2e8333385420ffe7bdd7", + "createdBy": "admin@pronoghorn", + "lastUpdatedBy": "admin@pronghorn", + "struct": { + "type": "object", + "description": "", + "items": [] + }, + "bindingSchema": {}, + "validationSchema": {}, + "tags": [], + "created": "2022-07-01T17:27:31.335Z", + "lastUpdated": "2022-07-01T17:27:31.335Z", + "name": "form-name", + "description": "", + "schema": { + "title": "form-name", + "description": "", + "type": "object", + "required": [], + "properties": {} + }, + "uiSchema": {}, + "version": "2022.1" + } + ] + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Deletes a forms", + "description": "Delete a list of JSON Forms from IAP.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.deleteForms", + "responses": { + "200": { + "description": "The status and number of delete forms.", + "content": { + "application/json": { + "schema": { + "title": "document", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "failure"] + }, + "n": { + "type": "integer" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ids": { + "title": "ids", + "type": "array", + "items": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + } + } + } + } + } + } + } + } + }, + "/json-forms/forms/{id}": { + "get": { + "summary": "Finds a form", + "description": "Finds a previously created JSON form, based on a supplied document ID.", + "tags": ["json-forms"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique name of the form", + "required": true, + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_formId" + } + } + ], + "operationId": "JsonForms.getFormById", + "responses": { + "200": { + "description": "document of requested form", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates a form", + "description": "Updates a previously created JSON form, based on a supplied document ID and an object of fields to update.", + "tags": ["json-forms"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the form.", + "required": true, + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_formId" + } + } + ], + "operationId": "JsonForms.updateForm", + "responses": { + "200": { + "description": "A response object containing the request status and a message", + "content": { + "application/json": { + "schema": { + "title": "document", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "failure"] + }, + "message": { + "type": "string", + "examples": ["Form updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + } + } + } + } + } + } + } + }, + "/json-forms/import/forms": { + "post": { + "summary": "Import form documents", + "description": "Insert form documents into the forms collection from a user supplied JSON document.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.importForms", + "responses": { + "200": { + "description": "Status of forms import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 forms imported successfully" + }, + "imported": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "original": { + "$ref": "#/components/schemas/json-forms_formDocument_importResultReport" + }, + "created": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/json-forms_formDocument_importResultReport" + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "forms": { + "title": "forms", + "type": "array", + "items": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + } + } + } + } + } + } + } + } + }, + "/json-forms/validate-form/{id}": { + "post": { + "summary": "Validates form data against its schema", + "description": "Retrieves the JSON schema for a given form ID and validates the supplied form data again it.", + "tags": ["json-forms"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique ID of the form", + "required": true, + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_formId" + } + } + ], + "operationId": "JsonForms.validateForm", + "responses": { + "200": { + "description": "results from the form validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_validationResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "formData": { + "$ref": "#/components/schemas/json-forms_formDocument_formData" + } + } + } + } + } + } + } + }, + "/json-forms/validate-data": { + "post": { + "summary": "Validates data against a schema.", + "description": "Performs data validation, given a JSON schema and form data.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.validateData", + "responses": { + "200": { + "description": "results from the form validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_validationResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jsonSchema": { + "$ref": "#/components/schemas/json-forms_metaSchema" + }, + "data": { + "$ref": "#/components/schemas/json-forms_formDocument_formData" + } + } + } + } + } + } + } + }, + "/json-forms/yangToSchema": { + "post": { + "summary": "Converts YANG to JSON Schema.", + "description": "onverts a list of YANG inputs into JSON Schemas", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.yangToSchema", + "responses": { + "200": { + "description": "Yang inputs converted to JSON schema", + "content": { + "application/json": { + "schema": { + "title": "jsonSchema", + "type": "array", + "items": { + "type": "object" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "yangData": { + "title": "yang", + "type": "array", + "items": { + "type": "string", + "description": "Yang module data in string format", + "examples": [ + "module Test { list interface { key \"name\"; leaf name { type string; } } }" + ] + } + } + } + } + } + } + } + } + }, + "/json-forms/decode": { + "post": { + "summary": "Decodes an encoded JSON Schema.", + "description": "Decodes an encoded JSON Schema.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.decodeSchema", + "responses": { + "200": { + "description": "Decoded Json Schema", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jsonSchema": { + "title": "jsonSchema", + "type": "object" + } + } + } + } + } + } + } + }, + "/ag-manager/actions": { + "get": { + "summary": "Merge discovered actions from all IAG adapters", + "description": "Discovers all actions from inputed IAG adapters. This will restart this app and display a corresponding log message.", + "tags": ["ag-manager"], + "parameters": [], + "operationId": "AGManager.discoverAll", + "responses": { + "200": { + "description": "A pronghorn.json object.", + "content": { + "application/json": { + "schema": { + "title": "pronghornJson", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AGManager.admin", "AGManager.apiread"], + "CookieAuth": ["AGManager.admin", "AGManager.apiread"], + "BasicAuth": ["AGManager.admin", "AGManager.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskContinuation": { + "title": "Task Continuation", + "type": "boolean", + "default": true + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove discovered actions from all IAG adapter", + "description": "Discovers all actions from all IAG adapters. This will restart this app and display a corresponding log message.", + "tags": ["ag-manager"], + "parameters": [], + "operationId": "AGManager.undiscoverAll", + "responses": { + "200": { + "description": "A pronghorn.json object.", + "content": { + "application/json": { + "schema": { + "title": "pronghornJson", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AGManager.admin", "AGManager.apiwrite"], + "CookieAuth": ["AGManager.admin", "AGManager.apiwrite"], + "BasicAuth": ["AGManager.admin", "AGManager.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskContinuation": { + "title": "Task Continuation", + "type": "boolean", + "default": true + } + } + } + } + } + } + } + }, + "/ag-manager/actions/{adapterId}": { + "get": { + "summary": "Discover actions on one IAG adapter", + "description": "Discovers all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.", + "tags": ["ag-manager"], + "parameters": [ + { + "name": "adapterId", + "in": "path", + "description": "Automation Gateway adapter ID.", + "required": true, + "schema": { + "title": "adapterId", + "type": "string" + } + } + ], + "operationId": "AGManager.discoverModules", + "responses": { + "200": { + "description": "A pronghorn.json object.", + "content": { + "application/json": { + "schema": { + "title": "pronghornJson", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AGManager.admin", "AGManager.apiread"], + "CookieAuth": ["AGManager.admin", "AGManager.apiread"], + "BasicAuth": ["AGManager.admin", "AGManager.apiread"] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Remove discovered actions from one IAG adapter", + "description": "Removes all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.", + "tags": ["ag-manager"], + "parameters": [ + { + "name": "adapterId", + "in": "path", + "description": "Automation Gateway adapter ID.", + "required": true, + "schema": { + "title": "adapterId", + "type": "string" + } + } + ], + "operationId": "AGManager.undiscoverModules", + "responses": { + "200": { + "description": "A pronghorn.json object.", + "content": { + "application/json": { + "schema": { + "title": "pronghornJson", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AGManager.admin", "AGManager.apiwrite"], + "CookieAuth": ["AGManager.admin", "AGManager.apiwrite"], + "BasicAuth": ["AGManager.admin", "AGManager.apiwrite"] + } + ], + "deprecated": false + } + }, + "/ag-manager/getClusterAdapters": { + "get": { + "summary": "Get all adapters in all clusters", + "description": "Get all adapters in all clusters", + "tags": ["ag-manager"], + "parameters": [], + "operationId": "AGManager.getClusterAdapters", + "responses": { + "200": { + "description": "A cluster adapter mapping object.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["AGManager.admin", "AGManager.apiread"], + "CookieAuth": ["AGManager.admin", "AGManager.apiread"], + "BasicAuth": ["AGManager.admin", "AGManager.apiread"] + } + ], + "deprecated": false + } + }, + "/workflow_builder/tasks/list": { + "get": { + "summary": "Get Tasks", + "description": "Get all Tasks.", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.getTasksList", + "responses": { + "200": { + "description": "List of all Tasks.", + "content": { + "application/json": { + "schema": { + "title": "task_list", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "location": { + "type": "string", + "enum": ["Application", "Adapter", "Broker"] + }, + "app": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["automatic", "manual", "operation"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + } + } + }, + "deprecated": { + "type": "boolean" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false + } + }, + "/workflow_builder/getTaskDetails/{app}/{task}": { + "get": { + "summary": "Get Task Details", + "description": "Get a Task's details.", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "app", + "in": "path", + "description": "Application's name (export field in model)", + "required": true, + "schema": { + "title": "app", + "type": "string", + "examples": ["ConfigurationManager"] + } + }, + { + "name": "task", + "in": "path", + "description": "Task's id (hex)", + "required": true, + "schema": { + "title": "task", + "type": "string", + "pattern": "^[0-9a-f]{1,4}$" + } + } + ], + "operationId": "WorkflowBuilder.getTaskDetails", + "responses": { + "200": { + "description": "Detailed Task.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_anyTask" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false + } + }, + "/workflow_builder/workflows/schemas": { + "post": { + "summary": "Calculate incoming/outgoing schemas for the workflow", + "description": "calculate incoming/outgoing schemas for the workflow", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.getSchemas", + "responses": { + "200": { + "description": "Input/Output transformation schemas for the workflow", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": { + "inputSchema": { + "type": "object" + }, + "outputSchema": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + } + } + } + } + } + } + } + }, + "/workflow_builder/workflows/save": { + "post": { + "summary": "Add Workflow", + "description": "Add a Workflow to the database", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.saveWorkflow", + "responses": { + "200": { + "description": "The new Workflow with its data and ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + } + } + } + } + } + } + } + }, + "/workflow_builder/workflows/rename": { + "post": { + "summary": "Rename Workflow", + "description": "Rename a Workflow in the database", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.renameWorkflow", + "responses": { + "200": { + "description": "The renamed Workflow with its data and ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + }, + "newName": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + } + } + } + } + } + }, + "/workflow_builder/workflows/delete/{name}": { + "delete": { + "summary": "Delete Workflow", + "description": "Delete a Workflow from the database", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Workflow's name.", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.deleteWorkflow", + "responses": { + "200": { + "description": "Status of delete", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false + } + }, + "/workflow_builder/workflows/{name}/groups": { + "get": { + "summary": "List Groups for a Workflow", + "description": "List the groups that have access to a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.listWorkflowGroups", + "responses": { + "200": { + "description": "List of Groups", + "content": { + "application/json": { + "schema": { + "title": "groups", + "type": "array", + "items": { + "title": "group", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "WorkflowBuilder.apiread", + "WorkflowBuilder.authorization" + ], + "CookieAuth": [ + "WorkflowBuilder.apiread", + "WorkflowBuilder.authorization" + ], + "BasicAuth": [ + "WorkflowBuilder.apiread", + "WorkflowBuilder.authorization" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Overwrite Groups for a Workflow", + "description": "Overwrite the list of groups that have access to a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.replaceWorkflowGroups", + "responses": { + "200": { + "description": "Status of Overwrite", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkflowBuilder.authorization"], + "CookieAuth": ["WorkflowBuilder.authorization"], + "BasicAuth": ["WorkflowBuilder.authorization"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "title": "groups", + "type": "array", + "items": { + "title": "group", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Add Group to Workflow", + "description": "Add a group to the list of groups for a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.createWorkflowGroupEntry", + "responses": { + "200": { + "description": "Status of Overwrite", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkflowBuilder.authorization"], + "CookieAuth": ["WorkflowBuilder.authorization"], + "BasicAuth": ["WorkflowBuilder.authorization"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "title": "group", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete all Groups for a Workflow", + "description": "Remove all authorization restriction for a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.deleteWorkflowGroups", + "responses": { + "200": { + "description": "Status of Delete", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkflowBuilder.authorization"], + "CookieAuth": ["WorkflowBuilder.authorization"], + "BasicAuth": ["WorkflowBuilder.authorization"] + } + ], + "deprecated": false + } + }, + "/workflow_builder/workflows/{name}/groups/{group}": { + "delete": { + "summary": "Remove a Group from a Workflow", + "description": "Remove a group from the list of authorized groups for a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + }, + { + "name": "group", + "in": "path", + "description": "A Group Name", + "required": true, + "schema": { + "title": "group", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + ], + "operationId": "WorkflowBuilder.removeWorkflowGroup", + "responses": { + "200": { + "description": "Status of Removal", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkflowBuilder.authorization"], + "CookieAuth": ["WorkflowBuilder.authorization"], + "BasicAuth": ["WorkflowBuilder.authorization"] + } + ], + "deprecated": false + } + }, + "/workflow_builder/export": { + "post": { + "summary": "Export Workflow", + "description": "Export a single Workflow", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.exportWorkflow", + "responses": { + "200": { + "description": "Exported Workflow", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowPayload" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"], + "CookieAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"], + "BasicAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectId", + "description": "Id of Workflow document", + "examples": [ + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "name": { + "type": "string", + "description": "The name of the workflow. When provided, 'type' can also be specified for additional filtering.", + "examples": ["ciscoIOSsoftwareUpgrade"] + }, + "type": { + "type": "string", + "description": "The type of the workflow. It is an optional field and is used in conjunction with 'name' for filtering." + } + }, + "required": ["_id", "name"], + "oneOf": [ + { + "required": ["_id"] + }, + { + "required": ["name"] + } + ], + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/workflow_builder/import": { + "post": { + "summary": "Import Workflow", + "description": "Import a single Workflow", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.importWorkflow", + "responses": { + "200": { + "description": "Import status Object", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "result" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["WorkflowBuilder.admin"], + "CookieAuth": ["WorkflowBuilder.admin"], + "BasicAuth": ["WorkflowBuilder.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/workflow_builder_workflowPayload" + }, + "options": { + "type": "object", + "properties": { + "adapterMap": { + "type": "object" + } + } + } + } + } + } + } + } + } + }, + "/template_builder/templates/{name}/renderJinja": { + "post": { + "summary": "Render Jinja Template", + "description": "Renders jinja template output.", + "tags": ["template_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Template name", + "required": true, + "schema": { + "type": "string", + "examples": [ + "Template name 1", + "Template name 2", + "Template name 3" + ] + } + } + ], + "operationId": "TemplateBuilder.renderJinjaTemplate", + "responses": { + "200": { + "description": "Rendered jinja template", + "content": { + "application/json": { + "schema": { + "title": "renderedTemplate", + "type": "object", + "examples": [ + { + "renderedTemplate": "John was born in year 2000" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ], + "CookieAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ], + "BasicAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "context": { + "type": "object", + "examples": [ + { + "name": "John", + "DOB": "2000/1/1" + } + ] + } + } + } + } + } + } + } + }, + "/template_builder/parseTemplate": { + "post": { + "summary": "Parse templates based on the text and textfsm template sent in.", + "description": "Parse templates based on the text and textfsm template sent in.", + "tags": ["template_builder"], + "parameters": [], + "operationId": "TemplateBuilder.parseTemplate", + "responses": { + "200": { + "description": "Results from textfsm", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ], + "CookieAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ], + "BasicAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/template_builder_parseTemplateInput" + } + } + } + } + } + } + } + }, + "/template_builder/applyTemplate": { + "post": { + "summary": "Apply a template to text", + "description": "Apply a template to parse text", + "tags": ["template_builder"], + "parameters": [], + "operationId": "TemplateBuilder.applyTemplate", + "responses": { + "200": { + "description": "Parsed object based on the template and text provided", + "content": { + "application/json": { + "schema": { + "title": "parsed", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], + "CookieAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], + "BasicAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "text": { + "type": "string", + "examples": [ + "Template input text 1", + "Template input text 2", + "Template input text 3" + ] + }, + "template": { + "type": "string", + "examples": [ + "Template name 1", + "Template name 2", + "Template name 3" + ] + } + } + } + } + } + } + } + }, + "/template_builder/applyTemplates": { + "post": { + "summary": "Apply templates to text", + "description": "Apply templates to parse text", + "tags": ["template_builder"], + "parameters": [], + "operationId": "TemplateBuilder.applyTemplates", + "responses": { + "200": { + "description": "Parsed text based on the templates used", + "content": { + "application/json": { + "schema": { + "title": "parsed", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + [ + "Template output 1", + "Template output 2", + "Template output 3" + ] + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], + "CookieAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], + "BasicAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "text": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + [ + "Template input text 1", + "Template input text 2", + "Template input text 3" + ] + ] + }, + "templates": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + ["Template name 1", "Template name 2", "Template name 3"] + ] + } + } + } + } + } + } + } + }, + "/operations-manager/automations/clone": { + "post": { + "summary": "Clone Automation", + "description": "Clone an Automation.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.cloneAutomation", + "responses": { + "200": { + "description": "The result of the clone operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_automation-api" + }, + "metadata": { + "type": "object", + "properties": { + "automaticChanges": { + "type": "array", + "items": { + "title": "messages", + "type": "string", + "example": "Disabled trigger 628672e8f677b67b3b0f20d7" + } + }, + "triggerCloneResults": { + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Imported 3 of 3 document(s)."] + }, + "metadata": { + "type": "object" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "data": { + "$ref": "#/components/schemas/operations-manager_trigger-api" + }, + "automaticChanges": { + "type": "array", + "items": { + "title": "messages", + "type": "string", + "example": "Disabled trigger 628672e8f677b67b3b0f20d7" + } + } + } + } + } + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "automation", + "content": { + "application/json": { + "schema": { + "title": "automation", + "properties": { + "id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + "name": { + "description": "An optional name to use for the clone.", + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/operations-manager_common_name" + } + ] + } + } + } + } + } + } + } + }, + "/operations-manager/automations": { + "post": { + "summary": "Create Automation", + "description": "Create a new Automation.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.createAutomation", + "responses": { + "200": { + "description": "The result of the create operation.", + "content": { + "application/json": { + "schema": { + "title": "results", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + "gbac": { + "$ref": "#/components/schemas/operations-manager_automation-common_gbac" + }, + "componentId": { + "$ref": "#/components/schemas/operations-manager_automation-common_componentId" + } + } + } + ] + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "automation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_automation-create" + } + } + } + } + }, + "get": { + "summary": "Get Automations", + "description": "Search the Automation collection.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.getAutomations", + "responses": { + "200": { + "description": "The Automations that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_automation-api" + } + }, + "metadata": { + "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Import Automations", + "description": "Import Automations.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.importAutomations", + "responses": { + "200": { + "description": "The result of the import operation.", + "content": { + "application/json": { + "schema": { + "title": "status", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + "gbac": { + "$ref": "#/components/schemas/operations-manager_automation-common_gbac" + }, + "componentId": { + "$ref": "#/components/schemas/operations-manager_automation-common_componentId" + } + } + } + ] + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "automations": { + "title": "automations", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_automation-json" + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "adapterMap": { + "type": "object", + "description": "A mapping of provenance names to be converted upon import, specified in \"old_name\": \"new_name\" format.", + "examples": [ + { + "staging": "production" + }, + { + "old_name": "new_name" + } + ] + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/operations-manager/automations/{id}": { + "delete": { + "summary": "Delete Automation", + "description": "Delete an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Automation to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteAutomation", + "responses": { + "200": { + "description": "The result of the delete operation.", + "content": { + "application/json": { + "schema": { + "title": "results", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "null" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get Automation", + "description": "Get an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Automation to get.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.getAutomation", + "responses": { + "200": { + "description": "The requested Automation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_automation-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update Automation", + "description": "Update an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Automation to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.updateAutomation", + "responses": { + "200": { + "description": "The result of the update operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + "gbac": { + "$ref": "#/components/schemas/operations-manager_automation-common_gbac" + }, + "componentId": { + "$ref": "#/components/schemas/operations-manager_automation-common_componentId" + } + } + } + ] + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_automation-update" + } + } + } + } + } + }, + "/operations-manager/automations/{id}/export": { + "get": { + "summary": "Export Automation", + "description": "Export an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Automation to export.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.exportAutomation", + "responses": { + "200": { + "description": "The result of the export operation.", + "content": { + "application/json": { + "schema": { + "title": "document", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_automation-json" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers": { + "get": { + "summary": "Get Triggers", + "description": "Search the Trigger collection.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document", + "required": false, + "schema": { + "type": "string", + "examples": ["event"], + "description": "the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document" + } + }, + { + "name": "containsField", + "in": "query", + "description": "the field to run a contains query on", + "required": false, + "schema": { + "type": "string", + "examples": ["name"], + "description": "the field to run a contains query on" + } + }, + { + "name": "equals", + "in": "query", + "description": "the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document", + "required": false, + "schema": { + "type": "string", + "examples": ["my event trigger"], + "description": "the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document" + } + }, + { + "name": "equalsField", + "in": "query", + "description": "the field to run an equals query on", + "required": false, + "schema": { + "type": "string", + "examples": ["name"], + "description": "the field to run an equals query on" + } + }, + { + "name": "startsWith", + "in": "query", + "description": "the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document", + "required": false, + "schema": { + "type": "string", + "examples": ["my"], + "description": "the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document" + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "the field to run a startsWith query on", + "required": false, + "schema": { + "type": "string", + "examples": ["name"], + "description": "the field to run a startsWith query on" + } + }, + { + "name": "greaterThanField", + "in": "query", + "description": "the field to run a greater than query on", + "required": false, + "schema": { + "type": "string", + "examples": ["lastExecuted"], + "description": "the field to run a greater than query on" + } + }, + { + "name": "greaterThan", + "in": "query", + "description": "the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds", + "required": false, + "schema": { + "type": "string", + "examples": [ + "04/06/2021", + "Thu Dec 03 2020 14:55:00 GMT-0500 (Eastern Standard Time)", + "2020-12-03T19:55:43.189Z", + "1617681600000" + ], + "description": "the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds" + } + }, + { + "name": "lessThanField", + "in": "query", + "description": "the field to run a less than query on", + "required": false, + "schema": { + "type": "string", + "examples": ["lastExecuted"], + "description": "the field to run a less than query on" + } + }, + { + "name": "lessThan", + "in": "query", + "description": "the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds", + "required": false, + "schema": { + "type": "string", + "examples": [ + "04/06/2021", + "Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time)", + "2020-12-03T19:55:43.189Z", + "1615611600000" + ], + "description": "the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds" + } + }, + { + "name": "enabled", + "in": "query", + "description": "if true, then only return trigger documents that are enabled", + "required": false, + "schema": { + "type": "boolean", + "description": "if true, then only return trigger documents that are enabled" + } + }, + { + "name": "actionId", + "in": "query", + "description": "if provided, only return trigger documents with this action id", + "required": false, + "schema": { + "type": "string", + "description": "if provided, only return trigger documents with this action id" + } + }, + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by. Default is name.", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by. Default is name.", + "default": "name", + "enum": ["name"] + } + } + ], + "operationId": "OperationsManager.getTriggers", + "responses": { + "200": { + "description": "The Triggers that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_trigger-api" + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Create Trigger", + "description": "Create a new Trigger.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.createTrigger", + "responses": { + "200": { + "description": "The result of the create operation.", + "content": { + "application/json": { + "schema": { + "title": "createdTigger", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + ] + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "trigger", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_trigger-create" + } + } + } + } + }, + "put": { + "summary": "Import Triggers", + "description": "Import Triggers.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.importTriggers", + "responses": { + "200": { + "description": "The result of the import operation.", + "content": { + "application/json": { + "schema": { + "title": "createdTigger", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + ] + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "triggers": { + "title": "triggers", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_trigger-json" + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "adapterMap": { + "type": "object", + "description": "A mapping of provenance names to be converted upon import, specified in \"old_name\": \"new_name\" format.", + "examples": [ + { + "staging": "production" + }, + { + "old_name": "new_name" + } + ] + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/operations-manager/triggers/{id}": { + "get": { + "summary": "Get Trigger", + "description": "Get a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Trigger to get.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.getTrigger", + "responses": { + "200": { + "description": "The requested Trigger.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_trigger-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update Trigger", + "description": "Update a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Trigger to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.updateTrigger", + "responses": { + "200": { + "description": "The result of the update operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + ] + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_trigger-update" + } + } + } + } + }, + "delete": { + "summary": "Delete Trigger", + "description": "Delete a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Trigger to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteTrigger", + "responses": { + "200": { + "description": "The result of the delete operation.", + "content": { + "application/json": { + "schema": { + "title": "success", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "null" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers/action/{id}": { + "delete": { + "summary": "Delete Triggers By Action ID", + "description": "Deletes all Triggers associated with the provided Automation id.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the parent Automation.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteTriggersByActionId", + "responses": { + "200": { + "description": "The result of the delete operation.", + "content": { + "application/json": { + "schema": { + "title": "deletedCount", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "null" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers/{id}/export": { + "get": { + "summary": "Export Trigger", + "description": "Export a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Trigger to export.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.exportTrigger", + "responses": { + "200": { + "description": "The result of the export operation.", + "content": { + "application/json": { + "schema": { + "title": "document", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_trigger-json" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/large-data/{id}": { + "get": { + "summary": "Export large data for a job or task variable", + "description": "Export large data for a job or task variable", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the job_data document in GridFS", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.exportLargeData", + "responses": { + "200": { + "description": "The requested data", + "content": { + "application/json": { + "schema": { + "title": "result", + "oneOf": [ + { + "type": "object" + }, + { + "type": "array" + }, + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "The decoded job data stored in GridFS" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/events": { + "get": { + "summary": "", + "description": "Search the system events that can be used in an event Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "source", + "in": "query", + "description": "source", + "required": false, + "schema": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" + } + }, + { + "name": "topic", + "in": "query", + "description": "topic", + "required": false, + "schema": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" + } + } + ], + "operationId": "OperationsManager.getEvents", + "responses": { + "200": { + "description": "The events that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" + }, + "topic": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/events/{source}/{topic}": { + "get": { + "summary": "", + "description": "Get an event definition.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "source", + "in": "path", + "description": "source", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" + } + }, + { + "name": "topic", + "in": "path", + "description": "topic", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" + } + } + ], + "operationId": "OperationsManager.getEventDefinition", + "responses": { + "200": { + "description": "The requested event definition.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" + }, + "topic": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" + }, + "definition": { + "type": "object", + "description": "The schema of the event.", + "$comment": "See draft 7 specification: http://json-schema.org/draft-07/schema#" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers/endpoint/{routeName}": { + "post": { + "summary": "Run Endpoint Trigger With POST", + "description": "Runs the Automation associated with the API Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "routeName", + "in": "path", + "description": "The routeName of the API Trigger.", + "required": true, + "schema": { + "title": "routeName", + "type": "string" + } + } + ], + "operationId": "OperationsManager.runEndpointTriggerWithPost", + "responses": { + "200": { + "description": "The spawned Job.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "body", + "content": { + "application/json": { + "schema": { + "title": "body", + "type": "object", + "properties": {}, + "additionalProperties": true + } + } + } + } + } + }, + "/operations-manager/triggers/manual/{id}/run": { + "post": { + "summary": "Run Manual Trigger", + "description": "Runs the Automation associated with the Manual Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Manual Trigger to run.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.runManualTrigger", + "responses": { + "200": { + "description": "The spawned Job.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "formData": { + "title": "formData", + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "runtimeOptions": { + "title": "runtimeOptions", + "default": {}, + "properties": { + "targetType": { + "enum": ["instance", "group"] + }, + "targetIdentifier": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/tasks/{taskId}/retry": { + "post": { + "summary": "Retry a task", + "description": "Retry a Task that has failed execution.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job containing the Task.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "taskId", + "in": "path", + "description": "The id of the Task to be retried.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_task-common_taskId" + } + } + ], + "operationId": "OperationsManager.retryTask", + "responses": { + "200": { + "description": "The result of the retry operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["OperationsManager.retryUser"], + "CookieAuth": ["OperationsManager.retryUser"], + "BasicAuth": ["OperationsManager.retryUser"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "variables": { + "title": "variables", + "type": "object", + "properties": {}, + "additionalProperties": true + } + } + } + } + } + } + } + }, + "/operations-manager/tasks/{taskId}/claim": { + "post": { + "summary": "Claim a task", + "description": "Assign a Task to the current user.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "taskId", + "in": "path", + "description": "The id of the Task iteration to be claimed.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_uuid-v4" + } + } + ], + "operationId": "OperationsManager.claimTask", + "responses": { + "200": { + "description": "The result of the claim operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/tasks/{taskId}/assign": { + "post": { + "summary": "Assign a task to a user", + "description": "Assign a Task to a user.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "taskId", + "in": "path", + "description": "The id of the Task iteration to be assigned.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_uuid-v4" + } + } + ], + "operationId": "OperationsManager.assignTask", + "responses": { + "200": { + "description": "The result of the assign operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + }, + "/operations-manager/tasks/{taskId}/release": { + "post": { + "summary": "Release a currently assigned task", + "description": "Remove user assignment from a currently assigned Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "taskId", + "in": "path", + "description": "The id of the Task iteration to be released.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_uuid-v4" + } + } + ], + "operationId": "OperationsManager.releaseTask", + "responses": { + "200": { + "description": "The result of the release operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/tasks": { + "get": { + "summary": "Gets Tasks", + "description": "Search the Task collection.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "in", + "in": "query", + "description": "Search for fields exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "not-in", + "in": "query", + "description": "Search for fields not exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "equals", + "in": "query", + "description": "Returns results where the specified fields exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string" + } + }, + { + "name": "contains", + "in": "query", + "description": "Returns results where the specified fields contain the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields contain the given match string(s).", + "type": "string" + } + }, + { + "name": "starts-with", + "in": "query", + "description": "Returns results where the specified fields start with the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string" + } + }, + { + "name": "ends-with", + "in": "query", + "description": "Returns results where the specified fields end in the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string" + } + }, + { + "name": "dereference", + "in": "query", + "description": "Designates foreign key fields to dereference in the API output.", + "required": false, + "schema": { + "description": "Designates foreign key fields to dereference in the API output.", + "type": "string" + } + }, + { + "name": "gt", + "in": "query", + "description": "Returns results where the specified fields have values greater than the specified values.", + "required": false, + "schema": { + "description": "Returns results where the specified fields have values greater than the specified values.", + "type": "string" + } + }, + { + "name": "gte", + "in": "query", + "description": "Returns results where the specified fields have values greater than or equal to the specified values.", + "required": false, + "schema": { + "description": "Returns results where the specified fields have values greater than or equal to the specified values.", + "type": "string" + } + }, + { + "name": "lt", + "in": "query", + "description": "Returns results where the specified fields have values less than the specified values.", + "required": false, + "schema": { + "description": "Returns results where the specified fields have values less than the specified values.", + "type": "string" + } + }, + { + "name": "lte", + "in": "query", + "description": "Returns results where the specified fields have values less than or equal to the specified values.", + "required": false, + "schema": { + "description": "Returns results where the specified fields have values less than or equal to the specified values.", + "type": "string" + } + }, + { + "name": "q", + "in": "query", + "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", + "required": false, + "schema": { + "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", + "type": "string" + } + }, + { + "name": "actionableTasks", + "in": "query", + "description": "If true, only returns actionable tasks that the current user has write access to.", + "required": false, + "schema": { + "type": "boolean", + "description": "If true, only returns actionable tasks that the current user has write access to.", + "default": false + } + } + ], + "operationId": "OperationsManager.getTasks", + "responses": { + "200": { + "description": "The Tasks that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + }, + "metadata": { + "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/tasks/{id}": { + "get": { + "summary": "Get a task by ID", + "description": "Get a Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Task to get.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "dereference", + "in": "query", + "description": "Designates foreign key fields to dereference in the API output. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.", + "required": false, + "schema": { + "type": "string", + "description": "Designates foreign key fields to dereference in the API output. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.", + "examples": ["job", "accounts.metrics.owner"] + } + } + ], + "operationId": "OperationsManager.getTask", + "responses": { + "200": { + "description": "The requested Task.", + "content": { + "application/json": { + "schema": { + "title": "task", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/{jobId}/watch": { + "post": { + "summary": "Watch a Job", + "description": "Adds the current user to the list of watchers on a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to watch.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.watchJob", + "responses": { + "200": { + "description": "The result of the watch operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/unwatch": { + "post": { + "summary": "Unwatch Jobs", + "description": "Removes the current user from the list of watchers on multiple Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.unwatchJobs", + "responses": { + "200": { + "description": "The result of the unwatch operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/watch": { + "post": { + "summary": "Watch Jobs", + "description": "Adds the current user to the list of watchers on multiple Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.watchJobs", + "responses": { + "200": { + "description": "The result of the watch operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/unwatch": { + "post": { + "summary": "Unwatch Job", + "description": "Removes the current user from the list of watchers on a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to unwatch.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.unwatchJob", + "responses": { + "200": { + "description": "The result of the unwatch operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/{jobId}/add-watchers": { + "post": { + "summary": "Add watchers to a Job", + "description": "Adds user ids to the list of watchers on a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to assign watchers to.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.addWatchersToJob", + "responses": { + "200": { + "description": "The result of the add watchers operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userIds": { + "title": "userIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/tasks/{taskId}/finish": { + "post": { + "summary": "Finish a manual task", + "description": "Work a manual Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job containing the Task to be worked.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "taskId", + "in": "path", + "description": "The id of the Task to be worked.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_job-common_taskId" + } + } + ], + "operationId": "OperationsManager.finishManualTask", + "responses": { + "200": { + "description": "The result of the finish manual Task operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskData": { + "title": "taskData", + "type": "object", + "properties": { + "finish_state": { + "type": "string" + }, + "variables": { + "type": "object" + } + }, + "required": ["finish_state", "variables"] + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/tasks/{taskId}/manual-controller": { + "get": { + "summary": "Get a client-side dialog controller for a manual task", + "description": "Get a client-side dialog controller for a manual task", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job containing the task", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "taskId", + "in": "path", + "description": "The id of the Task containing the dialog controller.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_task-common_taskId" + } + } + ], + "operationId": "OperationsManager.getManualTaskController", + "responses": { + "200": { + "description": "The requested dialog controller.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string" + }, + "decorators": { + "$ref": "#/components/schemas/operations-manager_common_decorators" + } + } + }, + "finish_state": { + "type": "string" + }, + "TaskController": { + "type": "string", + "description": "A Javascript function named TaskController." + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/{id}": { + "get": { + "summary": "Get a Job", + "description": "Get a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Job to get.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "dereference", + "in": "query", + "description": "Designates foreign key fields to dereference in the API output.", + "required": false, + "schema": { + "type": "string", + "description": "Designates foreign key fields to dereference in the API output.", + "examples": ["tasks", "accounts.createdBy"] + } + } + ], + "operationId": "OperationsManager.getJob", + "responses": { + "200": { + "description": "The requested Job.", + "content": { + "application/json": { + "schema": { + "title": "job", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs": { + "get": { + "summary": "Gets Jobs", + "description": "Search the Job collection.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.getJobs", + "responses": { + "200": { + "description": "The Jobs that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + }, + "metadata": { + "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/start": { + "post": { + "summary": "Start a Job", + "description": "Spawns a Job from a Workflow.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.startJob", + "responses": { + "200": { + "description": "The spawned Job.", + "content": { + "application/json": { + "schema": { + "title": "job", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "title": "workflow", + "type": "string" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description for the new Job.", + "examples": ["Example job description"] + }, + "type": { + "type": "string", + "examples": ["automation"] + }, + "variables": { + "type": "object", + "description": "Variables for the new Job.", + "additionalProperties": true + }, + "groups": { + "type": "array", + "description": "GBAC for the new Job.", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/pause": { + "post": { + "summary": "Pauses Jobs", + "description": "Pause active Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.pauseJobs", + "responses": { + "200": { + "description": "The result of the pause operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/resume": { + "post": { + "summary": "Resumes Jobs", + "description": "Resumes paused Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.resumeJobs", + "responses": { + "200": { + "description": "The result of the resume operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/cancel": { + "post": { + "summary": "Cancels Jobs", + "description": "Cancel Active Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.cancelJobs", + "responses": { + "200": { + "description": "The result of the cancel operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "type": "array", + "title": "jobIds", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/groups": { + "post": { + "summary": "Add GBAC to a Job", + "description": "Add a group id to the groups array of a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to modify.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.addJobGroup", + "responses": { + "200": { + "description": "The result of the add group operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "const": true + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupId": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove all GBAC from a Job", + "description": "Remove all groups from the groups array of a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to modify.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteJobGroups", + "responses": { + "200": { + "description": "The result of the delete groups operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "const": true + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Replace all GBAC from a Job with the provided list", + "description": "Replace all groups from the groups array of a Job with the provided group array.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to modify.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.replaceJobGroups", + "responses": { + "200": { + "description": "The result of the replace groups operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "const": true + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "title": "groups", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/groups/{groupId}": { + "delete": { + "summary": "Remove GBAC from a Job", + "description": "Remove a group id from the groups array of a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to modify.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "groupId", + "in": "path", + "description": "The group id to add to the Job.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteJobGroup", + "responses": { + "200": { + "description": "The result of the delete group operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "const": true + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/{jobId}": { + "delete": { + "summary": "Delete a root job and all related items", + "description": "Only succeeds on completed or cancelled root jobs. Recursively deletes children, tasks, job data, job history, and large files.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteJob", + "responses": { + "200": { + "description": "The result of the delete job operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object" + } + }, + "metadata": { + "type": "object" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/delete": { + "post": { + "summary": "Deletes a list of provided root jobs and all their related items", + "description": "Only succeeds on completed or cancelled root jobs. Ignores jobs that don't fit that criteria. Recursively deletes children, tasks, job data, job history, and large files.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.deleteJobs", + "responses": { + "200": { + "description": "The result of the delete jobs operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object" + } + }, + "metadata": { + "type": "object" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/continue": { + "post": { + "summary": "Continue a Job from a specified Task", + "description": "Continue a Job from a specified Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to be continued.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.continueJobFrom", + "responses": { + "200": { + "description": "The result of the continue operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["OperationsManager.retryUser"], + "CookieAuth": ["OperationsManager.retryUser"], + "BasicAuth": ["OperationsManager.retryUser"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fromTask": { + "$ref": "#/components/schemas/operations-manager_task-common_taskId" + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/revert": { + "post": { + "summary": "Revert a Job", + "description": "Revert a paused Job from an errored Task to a previously completed Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to be reverted.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.revertJob", + "responses": { + "200": { + "description": "The result of the revert operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fromTask": { + "$ref": "#/components/schemas/operations-manager_task-common_taskId" + }, + "toTask": { + "$ref": "#/components/schemas/operations-manager_job-common_taskId" + } + } + } + } + } + } + } + }, + "/operations-manager/automations/{automationIdentifier}/validate": { + "post": { + "summary": "Validate Automation", + "description": "Run configuration validations against an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "automationIdentifier", + "in": "path", + "description": "automationIdentifier", + "required": true, + "schema": { + "title": "automationIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/operations-manager_common_name" + } + ] + } + } + ], + "operationId": "OperationsManager.validateAutomation", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + }, + "warnings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers/{triggerId}/validate": { + "post": { + "summary": "Validate Trigger", + "description": "Run configuration validations against a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "triggerId", + "in": "path", + "description": "triggerId", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.validateTrigger", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + }, + "warnings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false + } + }, + "/mop/export": { + "post": { + "summary": "Export Template", + "description": "Export a single template", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.exportTemplate", + "responses": { + "200": { + "description": "Exported Template", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + }, + { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiread"], + "CookieAuth": ["MOP.admin", "MOP.apiread"], + "BasicAuth": ["MOP.admin", "MOP.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "examples": [ + { + "_id": "mop_test_123" + }, + { + "name": "mop_test_123" + } + ] + }, + "type": { + "title": "type", + "type": "string", + "enum": ["templates", "analytics"] + } + } + } + } + } + } + } + }, + "/mop/import": { + "post": { + "summary": "Import Template", + "description": "Import a single template", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.importTemplate", + "responses": { + "200": { + "description": "Import status", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "anyOf": [ + { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + }, + { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + ] + }, + "type": { + "type": "string", + "title": "type", + "enum": ["templates", "analytics"] + } + } + } + } + } + } + } + }, + "/mop/listTemplates": { + "get": { + "summary": "Get All Command Templates", + "description": "Get all Command Templates.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.listTemplates", + "responses": { + "200": { + "description": "All Command Templates.", + "content": { + "application/json": { + "schema": { + "title": "listTemplates", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false + } + }, + "/mop/listATemplate/{name}": { + "get": { + "summary": "Get a Command Template by Name", + "description": "Get a Command Template by name.", + "tags": ["mop"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the Command Template.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_name" + } + } + ], + "operationId": "MOP.listATemplate", + "responses": { + "200": { + "description": "Single Command Template matching the name.", + "content": { + "application/json": { + "schema": { + "title": "listATemplate", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false + } + }, + "/mop/listAnAnalyticTemplate/{name}": { + "get": { + "summary": "Get an Analytic Template by Name", + "description": "Get an Analytic Template by name.", + "tags": ["mop"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the Analytic Template.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc_name" + } + } + ], + "operationId": "MOP.listAnAnalyticTemplate", + "responses": { + "200": { + "description": "Single Analytic Template wrapped in an array.", + "content": { + "application/json": { + "schema": { + "title": "listAnAnalyticTemplate", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false + } + }, + "/mop/listAnalyticTemplates": { + "get": { + "summary": "Get All Analytic Templates", + "description": "Get all Analytic Templates.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.listAnalyticTemplates", + "responses": { + "200": { + "description": "All Analytic Templates.", + "content": { + "application/json": { + "schema": { + "title": "listAnalyticTemplates", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false + } + }, + "/mop/createTemplate": { + "post": { + "summary": "Create a Command Template", + "description": "Create a Command Template.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.createTemplate", + "responses": { + "200": { + "description": "Result of the creation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mop": { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + } + } + } + } + } + } + } + }, + "/mop/createAnalyticTemplate": { + "post": { + "summary": "Create an Analytic Template", + "description": "Create an Analytic Template.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.createAnalyticTemplate", + "responses": { + "200": { + "description": "Result of the creation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + } + } + } + } + }, + "/mop/deleteTemplate/{id}": { + "post": { + "summary": "Delete a Command Template", + "description": "Delete a Command Template by ID.", + "tags": ["mop"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ID of the template to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc__id" + } + } + ], + "operationId": "MOP.deleteTemplate", + "responses": { + "200": { + "description": "Status of the deletion.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false + } + }, + "/mop/deleteAnalyticTemplate/{id}": { + "post": { + "summary": "Delete an Analytic Template", + "description": "Delete an Analytic Template by ID.", + "tags": ["mop"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ID of the Analytic Template to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc__id" + } + } + ], + "operationId": "MOP.deleteAnalyticTemplate", + "responses": { + "200": { + "description": "Status of the deletion.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false + } + }, + "/mop/updateTemplate/{mopID}": { + "post": { + "summary": "Update a Command Template", + "description": "Update a Command Template by ID.", + "tags": ["mop"], + "parameters": [ + { + "name": "mopID", + "in": "path", + "description": "ID of the Command Template to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_name" + } + }, + { + "name": "mop", + "in": "path", + "description": "Command Template to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + } + } + ], + "operationId": "MOP.updateTemplate", + "responses": { + "200": { + "description": "Status of the update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false + } + }, + "/mop/updateAnalyticTemplate/{mopID}": { + "post": { + "summary": "Update an Analytic Template", + "description": "Update an Analytic Template by ID.", + "tags": ["mop"], + "parameters": [ + { + "name": "mopID", + "in": "path", + "description": "ID of the Analytic Template to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc__id" + } + } + ], + "operationId": "MOP.updateAnalyticTemplate", + "responses": { + "200": { + "description": "Status of the update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + } + } + } + } + }, + "/mop/RunCommandDevices": { + "post": { + "summary": "Run a Command against Devices", + "description": "Run a command against devices.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.RunCommandDevices", + "responses": { + "200": { + "description": "Result of the command run.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "command": { + "title": "command", + "type": "string", + "examples": ["show version"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + }, + "devices": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + } + } + } + } + } + } + } + }, + "/mop/RunCommand": { + "post": { + "summary": "Run a Command against a Device", + "description": "Run a command against a device.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.RunCommand", + "responses": { + "200": { + "description": "Result of the command run.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "command": { + "title": "command", + "type": "string", + "examples": ["show version"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + }, + "device": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_device" + } + } + } + } + } + } + } + }, + "/mop/RunCommandTemplate": { + "post": { + "summary": "Run Command Template", + "description": "Run a Command Template against devices.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.RunCommandTemplate", + "responses": { + "200": { + "description": "Result of the Command Template run.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "title": "template", + "type": "string", + "examples": ["show version"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + }, + "devices": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + } + } + } + } + } + } + } + }, + "/mop/RunCommandTemplateSingleCommand": { + "post": { + "summary": "Run single command from template", + "description": "Run a single command from a template on a devices.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.RunCommandTemplateSingleCommand", + "responses": { + "200": { + "description": "Result of the Command Template run.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "templateId": { + "$ref": "#/components/schemas/mop_mopTemplateDoc__id" + }, + "commandIndex": { + "title": "commandIndex", + "type": "integer", + "examples": [0] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + }, + "devices": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + } + } + } + } + } + } + } + }, + "/mop/GetBootFlash": { + "post": { + "summary": "MOP Get Boot Flash", + "description": "Get the boot flash image", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.GetBootFlash", + "responses": { + "200": { + "description": "Binary file name currently being used by router", + "content": { + "application/json": { + "schema": { + "title": "imageName", + "type": "string", + "examples": ["10011011"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "device": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_device" + } + } + } + } + } + } + } + }, + "/mop/passThru/{device}": { + "post": { + "summary": "MOP Pass Thru", + "description": "Pass Through to execute direct device commands", + "tags": ["mop"], + "parameters": [ + { + "name": "device", + "in": "path", + "description": "device", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_device" + } + } + ], + "operationId": "MOP.passThru", + "responses": { + "200": { + "description": "config", + "content": { + "application/json": { + "schema": { + "title": "config", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "command": { + "title": "command", + "type": "string", + "examples": ["show version"] + } + } + } + } + } + } + } + }, + "/mop/deviceObjects": { + "post": { + "summary": "Get Filtered Devices", + "description": "Get the devices with name matching the given options.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.getDeviceObjectsFiltered", + "responses": { + "200": { + "description": "Filtered devices", + "content": { + "application/json": { + "schema": { + "title": "devices", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_detailedDevice" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_options" + } + } + } + } + } + } + } + }, + "/mop/devices/detailed/{substring}": { + "get": { + "summary": "Get Filtered Devices with detailed query results", + "description": "Get the devices with name matching the given string. Also returns the number of results found and number returned", + "tags": ["mop"], + "parameters": [ + { + "name": "substring", + "in": "path", + "description": "String to filter devices", + "required": true, + "schema": { + "title": "substring", + "type": "string", + "examples": ["tes"] + } + } + ], + "operationId": "MOP.getDevicesFilteredDetailedResults", + "responses": { + "200": { + "description": "Filtered devices", + "content": { + "application/json": { + "schema": { + "title": "devices", + "type": "object", + "properties": { + "num_results": { + "type": "integer" + }, + "results": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + }, + "total_results": { + "type": "integer" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] + } + ], + "deprecated": false + } + }, + "/mop/diff": { + "post": { + "summary": "Find the diff of two config strings.", + "description": "Find the diff of two config strings.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.getDiff", + "responses": { + "200": { + "description": "Result of the diff.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "array", + "items": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "value": { + "type": "string" + }, + "added": { + "type": "boolean" + }, + "removed": { + "type": "boolean" + } + } + }, + "examples": [ + [ + [ + { + "count": 1, + "value": "example string\n" + }, + { + "count": 2, + "removed": true, + "value": "example string\nextra added line" + } + ] + ] + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "value_a": { + "title": "value_a", + "type": "string", + "examples": ["any string"] + }, + "value_b": { + "title": "value_b", + "type": "string", + "examples": ["other string"] + } + } + } + } + } + } + } + }, + "/mop/runTemplatesDiffArray": { + "post": { + "summary": "MOP Diff Array", + "description": "Generates a diff for the input. By default, the API call timeout is 5 minutes for the platform. If this API call needs additional time, it can be modified in the Express timeout property. The supported timeout range would be a minimum of 8 minutes for a 2MB payload and a maximum of 32 minutes for a 4MB payload.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.runTemplatesDiffArray", + "responses": { + "200": { + "description": "diff", + "content": { + "application/json": { + "schema": { + "title": "diff", + "type": "object", + "properties": { + "onlyPre": { + "type": "object", + "properties": {} + }, + "diff": { + "type": "object", + "properties": {} + }, + "onlyPost": { + "type": "object", + "properties": {} + }, + "analytics": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pre": { + "title": "pre", + "type": "array", + "items": { + "type": "string", + "examples": ["show version"] + } + }, + "post": { + "title": "post", + "type": "array", + "items": { + "type": "string", + "examples": ["show version"] + } + } + } + } + } + } + } + } + }, + "/mop/runAnalyticsTemplate": { + "post": { + "summary": "Run an Analytics Template", + "description": "Run an Analytic Template.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.runAnalyticsTemplate", + "responses": { + "200": { + "description": "Result of running Analytic Template", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pre": { + "title": "pre", + "type": "object", + "properties": { + "command": { + "type": "string" + }, + "commands_results": { + "type": "string" + } + }, + "examples": [ + { + "command": "show version", + "commands_results": "Cisco IOS Software, Version 1.2.3" + } + ] + }, + "post": { + "title": "post", + "type": "object", + "properties": { + "command": { + "type": "string" + }, + "commands_results": { + "type": "string" + } + }, + "examples": [ + { + "command": "show version", + "commands_results": "Cisco IOS Software, Version 1.2.3" + } + ] + }, + "analytic_template_name": { + "title": "analytic_template_name", + "type": "string", + "examples": ["test"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + } + } + } + } + } + } + } + }, + "/mop/runAnalyticsTemplateDevices": { + "post": { + "summary": "Run an Analytics Template for Devices", + "description": "Run an Analytic Template for Devices.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.runAnalyticsTemplateDevices", + "responses": { + "200": { + "description": "Result of running Analytic Template Devices", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pre": { + "title": "pre", + "type": "object", + "properties": { + "pre": { + "type": "object", + "properties": { + "commands_results": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["commands_results"], + "additionalProperties": false + } + } + }, + "post": { + "title": "post", + "type": "object", + "properties": { + "post": { + "type": "object", + "properties": { + "commands_results": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["commands_results"], + "additionalProperties": false + } + } + }, + "analytic_template_name": { + "title": "analytic_template_name", + "type": "string", + "examples": ["test"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + } + } + } + } + } + } + } + }, + "/mop/reattempt": { + "post": { + "summary": "Retry a task automatically for x number of attempts with n minute intervals.", + "description": "Workflow will follow reattempt task's outgoing transition after n minutes of delay.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.reattempt", + "responses": { + "200": { + "description": "Response from attempt", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "string", + "examples": ["Success"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "job_id": { + "title": "job_id", + "type": "string", + "examples": ["test"] + }, + "attemptID": { + "title": "attemptID", + "type": "string", + "examples": ["test1234"] + }, + "minutes": { + "title": "minutes", + "type": "integer", + "examples": [1] + }, + "attempts": { + "title": "attempts", + "type": "integer", + "examples": [2] + } + } + } + } + } + } + } + }, + "/mop/devices/{substring}": { + "get": { + "summary": "Get Filtered Devices", + "description": "Get the devices with name matching the given string.", + "tags": ["mop"], + "parameters": [ + { + "name": "substring", + "in": "path", + "description": "String to filter devices", + "required": true, + "schema": { + "title": "substring", + "type": "string", + "examples": ["tes"] + } + } + ], + "operationId": "MOP.getDevicesFiltered", + "responses": { + "200": { + "description": "Filtered devices", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/action-executions/{executionId}/cancel": { + "post": { + "summary": "Cancels an action execution", + "description": "Cancels an action execution, if targeting a bulk action execution, all its child executions will also be canceled.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "executionId", + "in": "path", + "description": "executionId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.cancelActionExecution", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/groups": { + "post": { + "summary": "Creates a new instance group", + "description": "Creates a new instance group", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.createInstanceGroupHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "instanceGroup", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-create" + } + } + } + } + }, + "get": { + "summary": "Gets multiple instance groups", + "description": "Gets multiple instance groups", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.getInstanceGroupsHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" + } + }, + "metadata": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources": { + "post": { + "summary": "Creates a new resource model", + "description": "Creates a new resource model", + "tags": ["lifecycle-manager"], + "parameters": [], + "operationId": "LifecycleManager.createResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "resourceModelData", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-create-data" + } + } + } + } + }, + "get": { + "summary": "Searches resource models", + "description": "Searches resource models", + "tags": ["lifecycle-manager"], + "parameters": [], + "operationId": "LifecycleManager.getResourceModelsHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" + } + }, + "metadata": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/groups/{groupIdentifier}": { + "delete": { + "summary": "Deletes an instance group", + "description": "Deletes an instance group", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + }, + { + "name": "groupIdentifier", + "in": "path", + "description": "groupIdentifier", + "required": true, + "schema": { + "title": "groupIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.deleteInstanceGroupHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + }, + "get": { + "summary": "Gets a single instance group", + "description": "Gets a single new instance group", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + }, + { + "name": "groupIdentifier", + "in": "path", + "description": "groupIdentifier", + "required": true, + "schema": { + "title": "groupIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.getInstanceGroupHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Updates a instance group", + "description": "Updates a instance group", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + }, + { + "name": "groupIdentifier", + "in": "path", + "description": "groupIdentifier", + "required": true, + "schema": { + "title": "groupIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.updateInstanceGroupHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-update" + } + } + } + } + } + }, + "/lifecycle-manager/resources/{id}": { + "delete": { + "summary": "Deletes a resource model", + "description": "A resource model will not be deleted if it has associated instances. To override this behavior and delete the resource model along with any associated instances, set the 'delete-associated-instances' flag to 'true'.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" + } + } + ], + "operationId": "LifecycleManager.deleteResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "queryParameters": { + "title": "queryParameters", + "type": "object", + "properties": { + "delete-associated-instances": { + "description": "If set to 'true', the resource model and any of its associated instances will be deleted.", + "type": "string" + } + }, + "required": [] + } + } + } + } + } + } + }, + "get": { + "summary": "Gets a resource model based on id", + "description": "Gets a resource model based on id", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ObjectId of the resource model", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" + } + }, + { + "name": "dereference", + "in": "query", + "description": "dereference", + "required": false, + "schema": { + "type": "string" + } + } + ], + "operationId": "LifecycleManager.getResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates a resource model", + "description": "Updates a resource model", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" + } + } + ], + "operationId": "LifecycleManager.updateResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "title": "updates", + "type": "object", + "properties": {} + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelId}/edit": { + "post": { + "summary": "Performs edits to a resource model", + "description": "Performs edits to a resource model. This method exists to support specific resource edit activities required by the UI.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Resource model ID", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.editResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "properties", + "content": { + "application/json": { + "schema": { + "title": "properties", + "oneOf": [ + { + "type": "object", + "required": ["command", "action"], + "properties": { + "command": { + "type": "string", + "description": "Edit command to execute", + "enum": [ + "generate-action-workflow", + "generate-action-pre-transformation", + "generate-action-post-transformation" + ] + }, + "action": { + "description": "Resource action ID or pending action definition", + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action" + } + ] + }, + "overwrite": { + "description": "Tells the component generator to either disregard and overwrite an existing component on the action (when true) or to refuse to generate a new component (when false).", + "type": "boolean" + }, + "updateAction": { + "description": "Tells the component generator to either update the action in the database (when true) or to only generate and return the new component (when false)", + "type": "boolean" + } + } + } + ] + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/instances/{instanceIdentifier}/export": { + "get": { + "summary": "Exports a resource instance", + "description": "This method exports a resource instance.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + }, + { + "name": "instanceIdentifier", + "in": "path", + "description": "instanceIdentifier", + "required": true, + "schema": { + "title": "instanceIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.exportResourceInstanceHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-export" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelId}/export": { + "get": { + "summary": "Exports a resource model", + "description": "This method exports a resource model.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "modelId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.exportResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": true, + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-export" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/action-executions/{id}": { + "get": { + "summary": "Gets a single action execution record", + "description": "Gets a single action execution record", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.getActionExecution", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": true, + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/action-executions": { + "get": { + "summary": "Searches resource action history documents", + "description": "Searches resource action history documents", + "tags": ["lifecycle-manager"], + "parameters": [], + "operationId": "LifecycleManager.getActionExecutions", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": true, + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" + } + }, + "metadata": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelId}/instances/{instanceId}": { + "get": { + "summary": "Gets a single resource instance", + "description": "Gets a single resource instance", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "modelId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + }, + { + "name": "instanceId", + "in": "path", + "description": "The identifier of the resource instance", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.getResourceInstanceHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates the `name` and `description` fields of a resource instance", + "description": "Updates the `name` and `description` fields of a resource instance", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "modelId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + }, + { + "name": "instanceId", + "in": "path", + "description": "instanceId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.updateInstanceMetadataHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "title": "updates", + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_name" + }, + "description": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_description" + } + } + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelId}/instances": { + "get": { + "summary": "Searches resource instances", + "description": "Searches resource instances", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "modelId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.getResourceInstancesHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + }, + "metadata": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/instances/import": { + "post": { + "summary": "Imports an instance into a resource", + "description": "Imports an instance into a resource", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.importResourceInstanceHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "instance", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-export" + } + } + } + } + } + }, + "/lifecycle-manager/resources/import": { + "post": { + "summary": "Imports a resource model", + "description": "Imports a resource model", + "tags": ["lifecycle-manager"], + "parameters": [], + "operationId": "LifecycleManager.importResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": true, + "properties": { + "data": { + "type": "object", + "additionalProperties": false, + "properties": { + "_id": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + }, + "name": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_name" + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "importParameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-import" + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelId}/run-action": { + "post": { + "summary": "Runs a resource action", + "description": "Runs a resource action", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "The ID of the Resource Model to run an action on", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.runActionHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "required": ["actionId"], + "additionalProperties": false, + "properties": { + "actionId": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" + }, + "instance": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + ] + }, + "instanceName": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_name" + }, + "instanceDescription": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_description" + }, + "inputs": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/run-bulk-action": { + "post": { + "summary": "Runs a resource action against multiple instances", + "description": "Runs a resource action against multiple instances", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "The ID of the Resource Model to run an action on.", + "required": true, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_name" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + ] + } + } + ], + "operationId": "LifecycleManager.runBulkActionHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "required": ["actionId"], + "additionalProperties": false, + "properties": { + "actionId": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" + }, + "group": { + "title": "groupIdentifier", + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + }, + "instances": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + }, + "inputs": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "inputOverrides": { + "oneOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ] + } + } + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelId}/actions/validate": { + "post": { + "summary": "Validates the actions defined on a resource model", + "description": "This method validates the actions on a resource model. Each validation report has an associate severity, and designates whether or not it will prevent the action from saving, prevent the model from running, or both. It accepts pending edits to actions in the optional 'actions' body parameter in order to check for validation issues on unsaved, pending changes to an action", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Resource model ID", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.validateActionsHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "OAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "properties", + "content": { + "application/json": { + "schema": { + "title": "properties", + "type": "object", + "required": [], + "properties": { + "actions": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_actions" + } + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "iap_accounts-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Account Schema", + "description": "This is the schema for an IAP account stored in Mongo", + "properties": { + "provenance": { + "title": "Provenance", + "description": "AAA provider where account originated", + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "title": "Username", + "description": "Username for account", + "type": "string", + "examples": ["john_doe"] + }, + "firstname": { + "title": "First Name", + "description": "The user's first name", + "type": "string", + "examples": ["John"] + }, + "memberOf": { + "title": "Assigned Groups", + "description": "Groups which this account is a part of", + "type": "array", + "items": { + "type": "object", + "properties": { + "aaaManaged": { + "description": "Whether group comes from an external AAA or not", + "type": "boolean" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "assignedRoles": { + "title": "Assigned Roles", + "description": "Roles assigned to this account", + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + }, + "additionalProperties": false + } + }, + "inactive": { + "title": "Inactive", + "description": "Setting for whether account is active or not", + "type": "boolean" + }, + "lastLogin": { + "title": "Last Login", + "description": "Date and time when the user last logged in", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "sso": { + "title": "sso", + "description": "Whether this is an SSO user", + "type": "boolean" + }, + "nameID": { + "title": "nameID", + "description": "Identifier for SSO account.", + "type": "string" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "title": "Created", + "description": "When the account was created", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updated": { + "title": "Updated", + "description": "When the account was last updated", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + } + } + }, + "email": { + "title": "Email", + "description": "Email for user", + "type": "string", + "examples": ["name@email.com"] + }, + "isServiceAccount": { + "description": "Value denoting if an account does not reflect a human user", + "type": "boolean" + }, + "loggedIn": { + "description": "Property used in the getAccounts API to indicate a user is currently logged in", + "type": "boolean" + }, + "gitTokens": { + "description": "Tokens used when interacting with Git APIs and features", + "type": "object", + "properties": { + "GitHub": { + "description": "Personal access token for GitHub", + "type": "string" + }, + "GitLab": { + "description": "Personal access token for GitLab", + "type": "string" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "provenance", + "username", + "firstname", + "memberOf", + "assignedRoles", + "inactive", + "gitTokens" + ] + }, + "iap_accounts-schema_username": { + "title": "Username", + "description": "Username for account", + "type": "string", + "examples": ["john_doe"] + }, + "iap_accounts-schema_inactive": { + "title": "Inactive", + "description": "Setting for whether account is active or not", + "type": "boolean" + }, + "iap_accounts-schema_memberOf": { + "title": "Assigned Groups", + "description": "Groups which this account is a part of", + "type": "array", + "items": { + "type": "object", + "properties": { + "aaaManaged": { + "description": "Whether group comes from an external AAA or not", + "type": "boolean" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "iap_accounts-schema_assignedRoles": { + "title": "Assigned Roles", + "description": "Roles assigned to this account", + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + }, + "additionalProperties": false + } + }, + "iap_accounts-schema_email": { + "title": "Email", + "description": "Email for user", + "type": "string", + "examples": ["name@email.com"] + }, + "iap_accounts-schema_isServiceAccount": { + "description": "Value denoting if an account does not reflect a human user", + "type": "boolean" + }, + "iap_accounts-schema_loggedIn": { + "description": "Property used in the getAccounts API to indicate a user is currently logged in", + "type": "boolean" + }, + "iap_accounts-schema_gitTokens": { + "description": "Tokens used when interacting with Git APIs and features", + "type": "object", + "properties": { + "GitHub": { + "description": "Personal access token for GitHub", + "type": "string" + }, + "GitLab": { + "description": "Personal access token for GitLab", + "type": "string" + } + }, + "additionalProperties": false + }, + "iap_common-schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "title": "Common schema definitions" + }, + "iap_common-schema_status": { + "type": "string", + "description": "The status of the API request.", + "enum": ["OK", "Created"] + }, + "iap_common-schema_message": { + "type": "string", + "description": "Message containing either confirmation of the operation or the reason for the failure of the operation.", + "examples": ["A sample success message"] + }, + "iap_common-schema_limit": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + }, + "iap_common-schema_skip": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + }, + "iap_common-schema_order": { + "type": "integer", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "default": 1, + "enum": [-1, 1] + }, + "iap_common-schema_sort": { + "type": "string", + "description": "Field to sort by. Default is name.", + "default": "name", + "enum": ["name"] + }, + "iap_common-schema_isActive": { + "type": "boolean", + "description": "Is profile the active profile.", + "examples": [true, false] + }, + "iap_common-schema_activeSync": { + "type": "boolean", + "description": "Is active profile in sync with the system.", + "examples": [true, false] + }, + "iap_common-schema_enabled": { + "type": "boolean", + "description": "A flag that denotes if the repository configuration is connected", + "enum": [true, false] + }, + "iap_common-schema_total": { + "type": "integer", + "description": "The total number of documents", + "minimum": 0, + "examples": [1, 5, 10, 20, 50] + }, + "iap_common-schema_type": { + "type": "string", + "description": "The type of Repository", + "enum": ["gitlab"] + }, + "iap_common-schema_hostname": { + "type": "string", + "description": "The hostname of the Respository endpoint", + "examples": ["gitlab.com"] + }, + "iap_common-schema_path": { + "type": "string", + "description": "The path of the Repository endpoint", + "examples": ["itentialopensource/pre-built-automations"] + }, + "iap_common-schema_credentials": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "An access token used to make HTTP requests", + "examples": ["uTc_P4pnMAEsLbQHmyOt"] + } + }, + "additionalProperties": false + }, + "iap_common-schema_config": { + "type": "string", + "description": "The name of the repository configuration that will be used to fetch Prebuilts", + "examples": ["@itentialopensource"] + }, + "iap_common-schema_objectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "iap_decorators-schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/redisProps/password"] + } + } + } + }, + "iap_indexes-schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "key": { + "type": "object", + "examples": [ + { + "name": 1 + } + ], + "additionalProperties": { + "type": "integer", + "enum": [-1, 1] + } + }, + "name": { + "type": "string", + "examples": ["name_1"] + }, + "background": { + "type": "boolean", + "enum": [true] + }, + "unique": { + "type": "boolean" + } + }, + "required": ["key", "background"] + }, + "iap_prebuilts-schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "@itentialopensource/aggregate-functions-for-arrays", + "@itentialopensource/cisco-nx-upgrade" + ] + }, + "version": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + }, + "description": { + "type": "string", + "examples": ["A basic description"] + }, + "author": { + "type": "string", + "examples": ["Itential Artifacts"] + }, + "license": { + "type": "string", + "examples": ["Apache-2.0"] + }, + "repository": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["local", "gitlab", "git"] + }, + "hostname": { + "type": "string", + "examples": ["gitlab.com", "localhost"] + }, + "path": { + "type": "string", + "examples": ["/itentialopensource/pre-built-automations"] + } + }, + "required": ["type"] + }, + "keywords": { + "type": "array", + "items": { + "type": "string", + "examples": ["Itential"] + } + }, + "IAPDependencies": { + "type": "object" + }, + "gitlabId": { + "type": "integer", + "examples": [17866482] + } + }, + "required": [ + "name", + "version", + "description", + "author", + "license", + "repository", + "IAPDependencies" + ], + "additionalProperties": false + }, + "manifest": { + "type": "object", + "properties": { + "bundleName": { + "type": "string", + "examples": ["aggregateFunctions"] + }, + "fingerprint": { + "type": "string", + "examples": ["5e84f892c5eab11ec2eee16d"] + }, + "createdEpoch": { + "type": "string", + "examples": ["1585772690392"] + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "examples": ["5e5ea3bd16da51d52b4a8f9f"] + }, + "name": { + "type": "string", + "examples": ["aggregateFunctions"] + }, + "type": { + "type": "string", + "enum": [ + "automation", + "forms", + "golden-config", + "integration", + "integration-model", + "json-forms", + "mop-template", + "mop-analytic-template", + "template", + "transformation", + "workflow" + ] + }, + "location": { + "type": "string", + "examples": [ + "/bundles/workflows/IAP Test Artifact Workflow.json" + ] + } + } + } + } + }, + "required": ["bundleName", "artifacts"], + "additionalProperties": false + }, + "bundles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "automation", + "forms", + "golden-config", + "integration", + "integration-model", + "json-forms", + "mop-template", + "mop-analytic-template", + "template", + "transformation", + "workflow" + ] + }, + "data": { + "type": "object" + } + }, + "required": ["type", "data"], + "additionalProperties": false + } + }, + "readme": { + "type": "string", + "examples": ["example of readme"], + "pattern": "^([\\S\\s]*)$" + } + }, + "required": ["metadata", "manifest", "bundles", "readme"], + "additionalProperties": false + }, + "iap_prebuilts-schema_readme": { + "type": "string", + "examples": ["example of readme"], + "pattern": "^([\\S\\s]*)$" + }, + "iap_prebuilts-schema_name": { + "type": "string", + "examples": [ + "@itentialopensource/aggregate-functions-for-arrays", + "@itentialopensource/cisco-nx-upgrade" + ] + }, + "iap_prebuilts-schema_version": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + }, + "iap_prebuilts-schema_description": { + "type": "string", + "examples": ["A basic description"] + }, + "iap_prebuilts-schema_author": { + "type": "string", + "examples": ["Itential Artifacts"] + }, + "iap_prebuilts-schema_license": { + "type": "string", + "examples": ["Apache-2.0"] + }, + "iap_prebuilts-schema_repository": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["local", "gitlab", "git"] + }, + "hostname": { + "type": "string", + "examples": ["gitlab.com", "localhost"] + }, + "path": { + "type": "string", + "examples": ["/itentialopensource/pre-built-automations"] + } + }, + "required": ["type"] + }, + "iap_prebuilts-schema_keywords": { + "type": "array", + "items": { + "type": "string", + "examples": ["Itential"] + } + }, + "iap_prebuilts-schema_IAPDependencies": { + "type": "object" + }, + "iap_profiles-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "The root schema", + "description": "The root schema comprises the entire JSON document.", + "properties": { + "uiProps": { + "type": "object", + "title": "UI Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["UI"] + }, + "layout": { + "type": "string", + "title": "Layout", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/layout.jade" + ] + }, + "home": { + "type": "string", + "title": "Home", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/home.jade" + ] + }, + "login": { + "type": "string", + "title": "Login", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/login.jade" + ] + }, + "profile": { + "type": "string", + "title": "Profile", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/profile.jade" + ] + }, + "fav_icon": { + "type": "string", + "title": "Favicon", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/img/favicon.ico" + ] + } + } + }, + "authenticationProps": { + "type": "object", + "title": "Authentication Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Authentication"] + }, + "logoutTime": { + "type": "integer", + "minimum": 2, + "description": "The maximum number of time IAP has to make an api call before the user is logged out, in minutes.", + "title": "Logout Time", + "examples": [20] + }, + "uniqueSession": { + "type": "boolean", + "description": "When uniqueSession is set to true, only one session may be enabled for a given user.", + "title": "Unique Session", + "examples": [false] + }, + "admins": { + "type": "array", + "title": "Admins", + "description": "Members of these groups will be implicitly assigned with admin permissions", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "description": "The name of the AAA adapter in which the groups reside.", + "title": "Provenance", + "examples": ["Local AAA"] + }, + "group": { + "type": "string", + "description": "The name of a user group which will have Pronghorn user management capabilities.", + "title": "Group", + "examples": ["admin"] + } + } + } + }, + "cookieName": { + "type": "string", + "description": "The name used by Pronghorn to identify cookies for user session data", + "title": "Cookie Name", + "examples": ["pronghorn_token"] + }, + "brokerPrincipal": { + "type": "boolean", + "description": "When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal.", + "title": "Broker Principal", + "examples": [false] + } + } + }, + "expressProps": { + "type": "object", + "title": "Express Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Express Server"] + }, + "cacheControl": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers.", + "title": "Cache Control", + "examples": [false] + }, + "timeout": { + "type": "integer", + "description": "The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client.", + "title": "Timeout", + "examples": [300000] + }, + "access_control_allow_origin": { + "type": "string", + "description": "The configured domain name for the Access-Control-Allow-Origin header used for security.", + "title": "Access-Control-Allow-Origin", + "examples": ["*"] + }, + "express_http": { + "type": "object", + "title": "Express HTTP Settings", + "properties": { + "enable": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests.", + "title": "Enable HTTP", + "examples": [false] + }, + "port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + } + } + }, + "express_https": { + "type": "object", + "title": "Express HTTPS Settings", + "properties": { + "enable": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests.", + "title": "Enable HTTPS", + "examples": [true] + }, + "port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + }, + "key": { + "type": "string", + "description": "The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property.", + "title": "Key", + "examples": ["/opt/pronghorn/current/keys/key.pem"] + }, + "passphrase": { + "type": "string", + "title": "Passphrase", + "description": "The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase." + }, + "cert": { + "type": "string", + "title": "Certificate", + "description": "The server's public certificate to use for all HTTPS transactions.", + "examples": ["/opt/pronghorn/current/keys/cert.pem"] + }, + "secureProtocol": { + "type": "string", + "description": "The secureProtocol can be used to configure the set of allowed SSL/TLS protocol versions.", + "title": "Secure Protocol", + "examples": ["TLSv1_2_method"], + "enum": ["TLSv1_method", "TLSv1_1_method", "TLSv1_2_method"] + }, + "ciphers": { + "type": "string", + "description": "The set of ciphers to allow when establishing an encrypted session.", + "title": "Ciphers", + "examples": [ + "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" + ] + }, + "client_reneg_limit": { + "type": "integer", + "description": "The maximum number of client renegotiations allowed per renegotiation window.", + "title": "Client Renegotiation Limit", + "examples": [1] + }, + "client_reneg_window": { + "type": "integer", + "description": "The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds.", + "title": "Client Renegotiation Window", + "examples": [600] + } + } + }, + "allowedHttpOptionalVerbs": { + "title": "Allowed HTTP Optional Verbs", + "description": "An array of optional HTTP verbs that are allowed to be used in requests to IAP", + "type": "array", + "uniqueItems": true, + "items": { + "enum": [ + "ACL", + "BIND", + "CHECKOUT", + "CONNECT", + "COPY", + "LINK", + "LOCK", + "MERGE", + "MKACTIVITY", + "MKCALENDAR", + "MKCOL", + "MOVE", + "M-SEARCH", + "NOTIFY", + "PROPFIND", + "PROPPATCH", + "PURGE", + "REBIND", + "REPORT", + "SEARCH", + "SUBSCRIBE", + "TRACE", + "UNBIND", + "UNLINK", + "UNLOCK", + "UNSUBSCRIBE" + ] + } + } + } + }, + "loggerProps": { + "type": "object", + "title": "Logger Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Logging"] + }, + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store Pronghorn log files.", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name of the current Pronghorn log file.", + "title": "Filename", + "examples": ["pronghorn.log"] + }, + "log_max_file_size": { + "type": "integer", + "title": "Max File Size", + "description": "The maximum size of each Pronghorn log file in bytes.", + "examples": [1048576] + }, + "log_max_files": { + "type": "integer", + "description": "The maximum number of log files maintained on the server.", + "title": "Max Number of Files", + "examples": [100] + }, + "log_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "console_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "webserver": { + "type": "object", + "description": "Determines how to set up the web server access log.", + "title": "Webserver", + "properties": { + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store web server access log files.", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name for the web server access log file.", + "title": "Filename", + "examples": ["webserver.log"] + } + } + }, + "syslog": { + "type": "object", + "description": "Allows Pronghorn to send log messages to a local or remote syslog daemon.", + "title": "Syslog", + "properties": { + "level": { + "type": "string", + "title": "Sys Log Level", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "host": { + "type": "string", + "description": "The host running syslogd.", + "title": "Host", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "description": "The port on the host that syslog is running on.", + "title": "Port", + "minimum": 1, + "maximum": 65535, + "examples": [514] + }, + "protocol": { + "type": "string", + "title": "Protocol", + "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", + "examples": ["udp4"], + "enum": ["tcp4", "udp4", "unix", "unix-connect"] + }, + "facility": { + "type": "string", + "description": "The syslog facility to use.", + "title": "Facility", + "examples": ["local0"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", + "examples": ["5424"], + "enum": ["BSD", "5424"] + }, + "path": { + "type": "string", + "title": "Path", + "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured.", + "format": "uri-reference", + "examples": ["/dev/log"] + }, + "pid": { + "type": "string", + "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", + "title": "Process ID", + "examples": ["process.pid"] + }, + "localhost": { + "type": "string", + "description": "The host to indicate that log messages are coming from.", + "title": "Log Host", + "examples": ["localhost"] + }, + "app_name": { + "type": "string", + "description": "The name of the application.", + "title": "Application Name", + "examples": ["process.title"] + }, + "eol": { + "type": "string", + "title": "End of Line Character", + "description": "The end of line character to be added to the end of the message.", + "examples": ["CR"] + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + }, + "redisProps": { + "type": "object", + "title": "Redis Properties", + "properties": { + "db": { + "type": "integer", + "description": "The Redis database number to connect to (may be any of 0-15).", + "title": "Database Number", + "examples": [0], + "minimum": 0 + }, + "username": { + "type": "string", + "title": "Username", + "description": "The username with access to the Redis DB.", + "examples": ["admin"] + }, + "password": { + "type": "string", + "title": "Password", + "description": "The passphrase protecting access to the Redis DB.", + "examples": [ + "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e" + ] + }, + "maxRetriesPerRequest": { + "type": "integer", + "description": "IAP will be shutdown after maxRetriesPerRequest is reached in case of lost Redis network connection.", + "title": "Max Retries Per Request", + "examples": [20] + }, + "maxHeartbeatWriteRetries": { + "type": "integer", + "description": "IAP will be shutdown after maxHeartbeatWriteRetries is reached in case of lost ability to write data in Redis.", + "title": "Max Heartbeat Write Retries", + "examples": [20] + } + }, + "oneOf": [ + { + "properties": { + "host": { + "type": "string", + "description": "The IP or hostname of the server running the Redis service.", + "title": "Host", + "examples": ["127.0.0.1", "localhost", "::1"] + }, + "port": { + "type": "integer", + "title": "Port", + "examples": [6379] + } + }, + "required": ["host", "port"] + }, + { + "properties": { + "sentinels": { + "type": "array", + "title": "Sentinels", + "items": { + "type": "object", + "properties": { + "host": { + "type": "string", + "title": "Host", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "title": "Port", + "examples": [26379] + } + } + }, + "description": "The list of Redis hosts for sentinel configuration." + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the master node in the Redis sentinel group." + } + }, + "required": ["sentinels", "name"] + } + ] + }, + "auditProps": { + "type": "object", + "title": "Audit Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Audit"] + }, + "audit": { + "type": "boolean", + "title": "Audit", + "examples": [true] + }, + "brokerValidation": { + "type": "boolean", + "title": "Broker Validation", + "examples": [true] + } + } + }, + "pathProps": { + "type": "object", + "title": "Path Properties", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "encrypted": { + "type": "boolean", + "description": "A boolean flag indicating Pronghorn core is encrypted.", + "title": "Encrypted", + "examples": [true] + } + } + }, + "alarmProps": { + "title": "Alarm Properties", + "type": "array", + "items": { + "type": "object", + "title": "Remote SNMP Config", + "description": "Remote SNMP destination config.", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "ip": { + "type": "string", + "format": "hostname", + "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", + "title": "Remote Server IP Address", + "examples": ["127.0.0.1"] + }, + "community": { + "type": "string", + "description": "The SNMP community to apply to the outgoing trap or inform.", + "title": "SNMP Community", + "examples": ["public"] + }, + "properties": { + "type": "object", + "properties": { + "retries": { + "type": "integer", + "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", + "title": "Retries", + "examples": [1] + }, + "timeout": { + "type": "integer", + "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", + "title": "Timeout", + "examples": [5000] + }, + "transport": { + "type": "string", + "description": "The protocol to use to send alarms to this receiver.", + "title": "Transport Protocol", + "examples": ["udp4"], + "enum": ["udp4", "udp6"] + }, + "trapPort": { + "type": "integer", + "description": "The remote port of this alarm receiver.", + "title": "SNMP Trap Port", + "examples": [162] + }, + "version": { + "type": "string", + "description": "The SNMP version to use when delivering notifications to this alarm receiver.", + "title": "SNMP Version", + "examples": ["V1"], + "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] + } + } + }, + "type": { + "type": "string", + "description": "The type can be configured as either a trap or inform.", + "title": "SNMP Type", + "examples": ["trap", "inform"], + "enum": ["trap", "inform"] + } + }, + "additionalProperties": false + }, + "minItems": 0 + }, + "id": { + "type": "string", + "title": "Profile ID", + "pattern": "^[^\\/]+$", + "examples": ["profile1"] + }, + "services": { + "type": "array", + "title": "Services", + "items": { + "type": "string", + "examples": ["WorkflowBuilder", "FormBuilder"] + } + }, + "description": { + "type": "string", + "title": "Description", + "examples": ["An IAP Profile"] + }, + "adapterStrategy": { + "type": "object", + "title": "Adapter Strategy", + "properties": { + "device": { + "title": "Device Calls", + "description": "Defines the order in which southbound systems are called.", + "properties": { + "adapterTypes": { + "type": "array", + "uniqueItems": true, + "title": "Adapter Types", + "description": "A list of adapter types that manages the devices.", + "items": { + "type": "string", + "enum": ["NSO", "AutomationGateway"] + } + }, + "exceptions": { + "type": "object", + "maxProperties": 1, + "title": "Exceptions", + "description": "An override for the runCommand's preference to a southbound system.", + "properties": { + "runCommand": { + "type": "string", + "title": "Run Command", + "description": "Runs a command on a device.", + "oneOf": [ + { + "const": "", + "title": "None" + }, + { + "const": "NSO", + "title": "NSO" + }, + { + "const": "AutomationGateway", + "title": "Automation Gateway" + } + ] + } + } + } + }, + "type": "object" + } + }, + "additionalProperties": true + }, + "systemProps": { + "type": "object", + "title": "System Properties", + "description": "Properties used to configure IAP process.", + "properties": { + "shutdownTimeout": { + "type": "integer", + "title": "Shutdown Timeout", + "minimum": 0, + "description": "The amount of time a service should wait before shutting down, in seconds.", + "examples": [3] + }, + "servicesBlacklist": { + "type": "array", + "title": "Services Blacklist", + "description": "An array of services that blocks CRUD operation access for each service listed.", + "items": { + "type": "string", + "description": "The service type that will be denied CRUD operation access.", + "examples": ["Local AAA"] + } + }, + "launchDelay": { + "type": "integer", + "title": "Launch Delay", + "minimum": 0, + "maximum": 60, + "description": "The application/adapter launch delay, in seconds.", + "examples": [5] + }, + "launchTimeout": { + "type": "integer", + "title": "Launch Timeout", + "minimum": 30, + "maximum": 1200, + "description": "The application/adapter launch timeout, in seconds.", + "examples": [60] + }, + "serviceHealthCheckInterval": { + "type": "integer", + "title": "Service Health Check Interval", + "minimum": 1, + "description": "How often to update service health, measured in seconds." + }, + "serviceHealthCheckUnhealthyThreshold": { + "type": "integer", + "title": "Service Health Check Unhealthy Threshold", + "minimum": 1, + "description": "Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline." + }, + "deadProcessCheck": { + "type": "boolean", + "title": "Dead Process Check", + "description": "Enable/disable IAP check for dead applications/adapters.", + "examples": [false, true] + }, + "deadProcessCheckInterval": { + "type": "integer", + "title": "Dead Process Check Interval", + "minimum": 5, + "maximum": 600, + "description": "How often to check if application/adapter stopped sending healthcheck pings, in seconds.", + "examples": [5] + }, + "deadProcessMaxPeriod": { + "type": "integer", + "title": "Dead Process Max Period", + "minimum": 15, + "maximum": 600, + "description": "Maximum time period for application/adapter without sending healthcheck ping, in seconds.", + "examples": [15] + }, + "externalRequestTimeout": { + "type": "integer", + "title": "External Request Timeout", + "minimum": 1, + "maximum": 120, + "description": "The timeout for external API requests, in seconds.", + "examples": [5, 10] + }, + "deviceCountPollingInterval": { + "type": "integer", + "title": "Device Count Polling Interval", + "minimum": 1, + "maximum": 168, + "description": "The interval for how often IAP polls for the number of devices, in hours.", + "examples": [24] + } + } + }, + "prebuiltProps": { + "type": "object", + "title": "Prebuilt Properties", + "properties": { + "repoConfigs": { + "type": "object", + "title": "Repository Configurations", + "description": "The configurations used to fetch Prebuilts from different repositories.", + "properties": { + "@itentialopensource": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "A flag that denotes if the repository configuration is connected", + "enum": [true, false] + }, + "type": { + "type": "string", + "description": "The type of Repository", + "enum": ["gitlab"] + }, + "hostname": { + "type": "string", + "description": "The hostname of the Respository endpoint", + "examples": ["gitlab.com"] + }, + "path": { + "type": "string", + "description": "The path of the Repository endpoint", + "examples": ["itentialopensource/pre-built-automations"] + }, + "credentials": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "An access token used to make HTTP requests", + "examples": ["uTc_P4pnMAEsLbQHmyOt"] + } + }, + "additionalProperties": false + } + } + } + }, + "additionalProperties": true + } + } + }, + "integrationProps": { + "type": "object", + "title": "Integration Properties", + "properties": { + "threadCount": { + "type": "integer", + "title": "Integrations Thread Count", + "minimum": 1, + "maximum": 16, + "description": "The number of threads available for API requests.", + "examples": [5] + }, + "timeout": { + "type": "integer", + "title": "Integrations Timeout", + "description": "The number of milliseconds until an integration request times out.", + "examples": [15000] + } + } + }, + "retryStrategy": { + "type": "object", + "title": "Retry Strategy", + "description": "Properties used to configure the strategy services use on crash.", + "properties": { + "maxRetries": { + "type": "integer", + "title": "Max Retries", + "minimum": 1, + "description": "Specifies the amount of times services will retry on crash before stopping.", + "examples": [5] + }, + "retryResetTimer": { + "type": "integer", + "title": "Retry Reset Timer", + "minimum": 0, + "description": "Specifies the amount of times between each retry before the count will reset in milliseconds.", + "examples": [30000] + } + } + }, + "serviceDirectory": { + "type": "string", + "title": "Service Directory", + "description": "Directory at which to find additional services." + } + }, + "additionalProperties": true + }, + "iap_profiles-schema_snmpConfig": { + "type": "object", + "title": "Remote SNMP Config", + "description": "Remote SNMP destination config.", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "ip": { + "type": "string", + "format": "hostname", + "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", + "title": "Remote Server IP Address", + "examples": ["127.0.0.1"] + }, + "community": { + "type": "string", + "description": "The SNMP community to apply to the outgoing trap or inform.", + "title": "SNMP Community", + "examples": ["public"] + }, + "properties": { + "type": "object", + "properties": { + "retries": { + "type": "integer", + "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", + "title": "Retries", + "examples": [1] + }, + "timeout": { + "type": "integer", + "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", + "title": "Timeout", + "examples": [5000] + }, + "transport": { + "type": "string", + "description": "The protocol to use to send alarms to this receiver.", + "title": "Transport Protocol", + "examples": ["udp4"], + "enum": ["udp4", "udp6"] + }, + "trapPort": { + "type": "integer", + "description": "The remote port of this alarm receiver.", + "title": "SNMP Trap Port", + "examples": [162] + }, + "version": { + "type": "string", + "description": "The SNMP version to use when delivering notifications to this alarm receiver.", + "title": "SNMP Version", + "examples": ["V1"], + "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] + } + } + }, + "type": { + "type": "string", + "description": "The type can be configured as either a trap or inform.", + "title": "SNMP Type", + "examples": ["trap", "inform"], + "enum": ["trap", "inform"] + } + }, + "additionalProperties": false + }, + "iap_profiles-schema_log_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "iap_profiles-schema_sys_log_level": { + "type": "string", + "title": "Sys Log Level", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "iap_profiles-schema_port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + }, + "iap_profiles-schema_uiProps": { + "type": "object", + "title": "UI Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["UI"] + }, + "layout": { + "type": "string", + "title": "Layout", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/layout.jade" + ] + }, + "home": { + "type": "string", + "title": "Home", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/home.jade" + ] + }, + "login": { + "type": "string", + "title": "Login", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/login.jade" + ] + }, + "profile": { + "type": "string", + "title": "Profile", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/profile.jade" + ] + }, + "fav_icon": { + "type": "string", + "title": "Favicon", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/img/favicon.ico" + ] + } + } + }, + "iap_profiles-schema_authenticationProps": { + "type": "object", + "title": "Authentication Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Authentication"] + }, + "logoutTime": { + "type": "integer", + "minimum": 2, + "description": "The maximum number of time IAP has to make an api call before the user is logged out, in minutes.", + "title": "Logout Time", + "examples": [20] + }, + "uniqueSession": { + "type": "boolean", + "description": "When uniqueSession is set to true, only one session may be enabled for a given user.", + "title": "Unique Session", + "examples": [false] + }, + "admins": { + "type": "array", + "title": "Admins", + "description": "Members of these groups will be implicitly assigned with admin permissions", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "description": "The name of the AAA adapter in which the groups reside.", + "title": "Provenance", + "examples": ["Local AAA"] + }, + "group": { + "type": "string", + "description": "The name of a user group which will have Pronghorn user management capabilities.", + "title": "Group", + "examples": ["admin"] + } + } + } + }, + "cookieName": { + "type": "string", + "description": "The name used by Pronghorn to identify cookies for user session data", + "title": "Cookie Name", + "examples": ["pronghorn_token"] + }, + "brokerPrincipal": { + "type": "boolean", + "description": "When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal.", + "title": "Broker Principal", + "examples": [false] + } + } + }, + "iap_profiles-schema_expressProps": { + "type": "object", + "title": "Express Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Express Server"] + }, + "cacheControl": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers.", + "title": "Cache Control", + "examples": [false] + }, + "timeout": { + "type": "integer", + "description": "The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client.", + "title": "Timeout", + "examples": [300000] + }, + "access_control_allow_origin": { + "type": "string", + "description": "The configured domain name for the Access-Control-Allow-Origin header used for security.", + "title": "Access-Control-Allow-Origin", + "examples": ["*"] + }, + "express_http": { + "type": "object", + "title": "Express HTTP Settings", + "properties": { + "enable": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests.", + "title": "Enable HTTP", + "examples": [false] + }, + "port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + } + } + }, + "express_https": { + "type": "object", + "title": "Express HTTPS Settings", + "properties": { + "enable": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests.", + "title": "Enable HTTPS", + "examples": [true] + }, + "port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + }, + "key": { + "type": "string", + "description": "The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property.", + "title": "Key", + "examples": ["/opt/pronghorn/current/keys/key.pem"] + }, + "passphrase": { + "type": "string", + "title": "Passphrase", + "description": "The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase." + }, + "cert": { + "type": "string", + "title": "Certificate", + "description": "The server's public certificate to use for all HTTPS transactions.", + "examples": ["/opt/pronghorn/current/keys/cert.pem"] + }, + "secureProtocol": { + "type": "string", + "description": "The secureProtocol can be used to configure the set of allowed SSL/TLS protocol versions.", + "title": "Secure Protocol", + "examples": ["TLSv1_2_method"], + "enum": ["TLSv1_method", "TLSv1_1_method", "TLSv1_2_method"] + }, + "ciphers": { + "type": "string", + "description": "The set of ciphers to allow when establishing an encrypted session.", + "title": "Ciphers", + "examples": [ + "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" + ] + }, + "client_reneg_limit": { + "type": "integer", + "description": "The maximum number of client renegotiations allowed per renegotiation window.", + "title": "Client Renegotiation Limit", + "examples": [1] + }, + "client_reneg_window": { + "type": "integer", + "description": "The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds.", + "title": "Client Renegotiation Window", + "examples": [600] + } + } + }, + "allowedHttpOptionalVerbs": { + "title": "Allowed HTTP Optional Verbs", + "description": "An array of optional HTTP verbs that are allowed to be used in requests to IAP", + "type": "array", + "uniqueItems": true, + "items": { + "enum": [ + "ACL", + "BIND", + "CHECKOUT", + "CONNECT", + "COPY", + "LINK", + "LOCK", + "MERGE", + "MKACTIVITY", + "MKCALENDAR", + "MKCOL", + "MOVE", + "M-SEARCH", + "NOTIFY", + "PROPFIND", + "PROPPATCH", + "PURGE", + "REBIND", + "REPORT", + "SEARCH", + "SUBSCRIBE", + "TRACE", + "UNBIND", + "UNLINK", + "UNLOCK", + "UNSUBSCRIBE" + ] + } + } + } + }, + "iap_profiles-schema_loggerProps": { + "type": "object", + "title": "Logger Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Logging"] + }, + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store Pronghorn log files.", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name of the current Pronghorn log file.", + "title": "Filename", + "examples": ["pronghorn.log"] + }, + "log_max_file_size": { + "type": "integer", + "title": "Max File Size", + "description": "The maximum size of each Pronghorn log file in bytes.", + "examples": [1048576] + }, + "log_max_files": { + "type": "integer", + "description": "The maximum number of log files maintained on the server.", + "title": "Max Number of Files", + "examples": [100] + }, + "log_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "console_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "webserver": { + "type": "object", + "description": "Determines how to set up the web server access log.", + "title": "Webserver", + "properties": { + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store web server access log files.", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name for the web server access log file.", + "title": "Filename", + "examples": ["webserver.log"] + } + } + }, + "syslog": { + "type": "object", + "description": "Allows Pronghorn to send log messages to a local or remote syslog daemon.", + "title": "Syslog", + "properties": { + "level": { + "type": "string", + "title": "Sys Log Level", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "host": { + "type": "string", + "description": "The host running syslogd.", + "title": "Host", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "description": "The port on the host that syslog is running on.", + "title": "Port", + "minimum": 1, + "maximum": 65535, + "examples": [514] + }, + "protocol": { + "type": "string", + "title": "Protocol", + "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", + "examples": ["udp4"], + "enum": ["tcp4", "udp4", "unix", "unix-connect"] + }, + "facility": { + "type": "string", + "description": "The syslog facility to use.", + "title": "Facility", + "examples": ["local0"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", + "examples": ["5424"], + "enum": ["BSD", "5424"] + }, + "path": { + "type": "string", + "title": "Path", + "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured.", + "format": "uri-reference", + "examples": ["/dev/log"] + }, + "pid": { + "type": "string", + "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", + "title": "Process ID", + "examples": ["process.pid"] + }, + "localhost": { + "type": "string", + "description": "The host to indicate that log messages are coming from.", + "title": "Log Host", + "examples": ["localhost"] + }, + "app_name": { + "type": "string", + "description": "The name of the application.", + "title": "Application Name", + "examples": ["process.title"] + }, + "eol": { + "type": "string", + "title": "End of Line Character", + "description": "The end of line character to be added to the end of the message.", + "examples": ["CR"] + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + }, + "iap_profiles-schema_redisProps": { + "type": "object", + "title": "Redis Properties", + "properties": { + "db": { + "type": "integer", + "description": "The Redis database number to connect to (may be any of 0-15).", + "title": "Database Number", + "examples": [0], + "minimum": 0 + }, + "username": { + "type": "string", + "title": "Username", + "description": "The username with access to the Redis DB.", + "examples": ["admin"] + }, + "password": { + "type": "string", + "title": "Password", + "description": "The passphrase protecting access to the Redis DB.", + "examples": ["$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e"] + }, + "maxRetriesPerRequest": { + "type": "integer", + "description": "IAP will be shutdown after maxRetriesPerRequest is reached in case of lost Redis network connection.", + "title": "Max Retries Per Request", + "examples": [20] + }, + "maxHeartbeatWriteRetries": { + "type": "integer", + "description": "IAP will be shutdown after maxHeartbeatWriteRetries is reached in case of lost ability to write data in Redis.", + "title": "Max Heartbeat Write Retries", + "examples": [20] + } + }, + "oneOf": [ + { + "properties": { + "host": { + "type": "string", + "description": "The IP or hostname of the server running the Redis service.", + "title": "Host", + "examples": ["127.0.0.1", "localhost", "::1"] + }, + "port": { + "type": "integer", + "title": "Port", + "examples": [6379] + } + }, + "required": ["host", "port"] + }, + { + "properties": { + "sentinels": { + "type": "array", + "title": "Sentinels", + "items": { + "type": "object", + "properties": { + "host": { + "type": "string", + "title": "Host", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "title": "Port", + "examples": [26379] + } + } + }, + "description": "The list of Redis hosts for sentinel configuration." + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the master node in the Redis sentinel group." + } + }, + "required": ["sentinels", "name"] + } + ] + }, + "iap_profiles-schema_auditProps": { + "type": "object", + "title": "Audit Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Audit"] + }, + "audit": { + "type": "boolean", + "title": "Audit", + "examples": [true] + }, + "brokerValidation": { + "type": "boolean", + "title": "Broker Validation", + "examples": [true] + } + } + }, + "iap_profiles-schema_pathProps": { + "type": "object", + "title": "Path Properties", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "encrypted": { + "type": "boolean", + "description": "A boolean flag indicating Pronghorn core is encrypted.", + "title": "Encrypted", + "examples": [true] + } + } + }, + "iap_profiles-schema_alarmProps": { + "title": "Alarm Properties", + "type": "array", + "items": { + "type": "object", + "title": "Remote SNMP Config", + "description": "Remote SNMP destination config.", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "ip": { + "type": "string", + "format": "hostname", + "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", + "title": "Remote Server IP Address", + "examples": ["127.0.0.1"] + }, + "community": { + "type": "string", + "description": "The SNMP community to apply to the outgoing trap or inform.", + "title": "SNMP Community", + "examples": ["public"] + }, + "properties": { + "type": "object", + "properties": { + "retries": { + "type": "integer", + "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", + "title": "Retries", + "examples": [1] + }, + "timeout": { + "type": "integer", + "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", + "title": "Timeout", + "examples": [5000] + }, + "transport": { + "type": "string", + "description": "The protocol to use to send alarms to this receiver.", + "title": "Transport Protocol", + "examples": ["udp4"], + "enum": ["udp4", "udp6"] + }, + "trapPort": { + "type": "integer", + "description": "The remote port of this alarm receiver.", + "title": "SNMP Trap Port", + "examples": [162] + }, + "version": { + "type": "string", + "description": "The SNMP version to use when delivering notifications to this alarm receiver.", + "title": "SNMP Version", + "examples": ["V1"], + "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] + } + } + }, + "type": { + "type": "string", + "description": "The type can be configured as either a trap or inform.", + "title": "SNMP Type", + "examples": ["trap", "inform"], + "enum": ["trap", "inform"] + } + }, + "additionalProperties": false + }, + "minItems": 0 + }, + "iap_profiles-schema_id": { + "type": "string", + "title": "Profile ID", + "pattern": "^[^\\/]+$", + "examples": ["profile1"] + }, + "iap_profiles-schema_services": { + "type": "array", + "title": "Services", + "items": { + "type": "string", + "examples": ["WorkflowBuilder", "FormBuilder"] + } + }, + "iap_profiles-schema_description": { + "type": "string", + "title": "Description", + "examples": ["An IAP Profile"] + }, + "iap_profiles-schema_adapterStrategy": { + "type": "object", + "title": "Adapter Strategy", + "properties": { + "device": { + "title": "Device Calls", + "description": "Defines the order in which southbound systems are called.", + "properties": { + "adapterTypes": { + "type": "array", + "uniqueItems": true, + "title": "Adapter Types", + "description": "A list of adapter types that manages the devices.", + "items": { + "type": "string", + "enum": ["NSO", "AutomationGateway"] + } + }, + "exceptions": { + "type": "object", + "maxProperties": 1, + "title": "Exceptions", + "description": "An override for the runCommand's preference to a southbound system.", + "properties": { + "runCommand": { + "type": "string", + "title": "Run Command", + "description": "Runs a command on a device.", + "oneOf": [ + { + "const": "", + "title": "None" + }, + { + "const": "NSO", + "title": "NSO" + }, + { + "const": "AutomationGateway", + "title": "Automation Gateway" + } + ] + } + } + } + }, + "type": "object" + } + }, + "additionalProperties": true + }, + "iap_profiles-schema_systemProps": { + "type": "object", + "title": "System Properties", + "description": "Properties used to configure IAP process.", + "properties": { + "shutdownTimeout": { + "type": "integer", + "title": "Shutdown Timeout", + "minimum": 0, + "description": "The amount of time a service should wait before shutting down, in seconds.", + "examples": [3] + }, + "servicesBlacklist": { + "type": "array", + "title": "Services Blacklist", + "description": "An array of services that blocks CRUD operation access for each service listed.", + "items": { + "type": "string", + "description": "The service type that will be denied CRUD operation access.", + "examples": ["Local AAA"] + } + }, + "launchDelay": { + "type": "integer", + "title": "Launch Delay", + "minimum": 0, + "maximum": 60, + "description": "The application/adapter launch delay, in seconds.", + "examples": [5] + }, + "launchTimeout": { + "type": "integer", + "title": "Launch Timeout", + "minimum": 30, + "maximum": 1200, + "description": "The application/adapter launch timeout, in seconds.", + "examples": [60] + }, + "serviceHealthCheckInterval": { + "type": "integer", + "title": "Service Health Check Interval", + "minimum": 1, + "description": "How often to update service health, measured in seconds." + }, + "serviceHealthCheckUnhealthyThreshold": { + "type": "integer", + "title": "Service Health Check Unhealthy Threshold", + "minimum": 1, + "description": "Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline." + }, + "deadProcessCheck": { + "type": "boolean", + "title": "Dead Process Check", + "description": "Enable/disable IAP check for dead applications/adapters.", + "examples": [false, true] + }, + "deadProcessCheckInterval": { + "type": "integer", + "title": "Dead Process Check Interval", + "minimum": 5, + "maximum": 600, + "description": "How often to check if application/adapter stopped sending healthcheck pings, in seconds.", + "examples": [5] + }, + "deadProcessMaxPeriod": { + "type": "integer", + "title": "Dead Process Max Period", + "minimum": 15, + "maximum": 600, + "description": "Maximum time period for application/adapter without sending healthcheck ping, in seconds.", + "examples": [15] + }, + "externalRequestTimeout": { + "type": "integer", + "title": "External Request Timeout", + "minimum": 1, + "maximum": 120, + "description": "The timeout for external API requests, in seconds.", + "examples": [5, 10] + }, + "deviceCountPollingInterval": { + "type": "integer", + "title": "Device Count Polling Interval", + "minimum": 1, + "maximum": 168, + "description": "The interval for how often IAP polls for the number of devices, in hours.", + "examples": [24] + } + } + }, + "iap_profiles-schema_integrationProps": { + "type": "object", + "title": "Integration Properties", + "properties": { + "threadCount": { + "type": "integer", + "title": "Integrations Thread Count", + "minimum": 1, + "maximum": 16, + "description": "The number of threads available for API requests.", + "examples": [5] + }, + "timeout": { + "type": "integer", + "title": "Integrations Timeout", + "description": "The number of milliseconds until an integration request times out.", + "examples": [15000] + } + } + }, + "iap_profiles-schema_retryStrategy": { + "type": "object", + "title": "Retry Strategy", + "description": "Properties used to configure the strategy services use on crash.", + "properties": { + "maxRetries": { + "type": "integer", + "title": "Max Retries", + "minimum": 1, + "description": "Specifies the amount of times services will retry on crash before stopping.", + "examples": [5] + }, + "retryResetTimer": { + "type": "integer", + "title": "Retry Reset Timer", + "minimum": 0, + "description": "Specifies the amount of times between each retry before the count will reset in milliseconds.", + "examples": [30000] + } + } + }, + "iap_profiles-schema_serviceDirectory": { + "type": "string", + "title": "Service Directory", + "description": "Directory at which to find additional services." + }, + "iap_services-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Services Schema", + "description": "All of the properties required for a service.", + "properties": { + "loggerProps": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description property", + "title": "Description", + "default": "Logger Settings", + "examples": ["Logging"] + }, + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store Pronghorn log files.", + "default": "/var/log/pronghorn", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name of the current Pronghorn log file.", + "title": "Filename", + "default": "pronghorn.log", + "examples": ["pronghorn.log"] + }, + "log_max_file_size": { + "type": "integer", + "title": "Max File Size", + "description": "The maximum size of each Pronghorn log file in bytes.", + "default": 1048576, + "examples": [1048576] + }, + "log_max_files": { + "type": "integer", + "description": "The maximum number of log files maintained on the server.", + "title": "Max Number of Files", + "default": 100, + "examples": [100] + }, + "log_timezone_offset": { + "type": "integer", + "description": "An integer specifying the offset from GMT/UTC time that will be used when writing to the log files.", + "title": "Timezone Offset", + "default": 0, + "examples": [-5], + "minimum": -12, + "maximum": 12 + }, + "log_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "console_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "metrics_filename": { + "type": "string", + "description": "The name of the job metrics log file, if applicable.", + "title": "Metrics Filename", + "default": "metrics.log", + "examples": ["metrics.log"] + }, + "metrics_max_files": { + "type": "integer", + "description": "The maximum number of job metrics log files maintained on the server, if applicable.", + "title": "Max Number of Metrics Files", + "default": 31, + "examples": [31] + }, + "metrics_rotation_interval": { + "type": "string", + "description": "The time until the metrics log is rotated in minutes, hours, days, or weeks, if applicable.", + "title": "Rotation Interval of Metrics Files", + "default": "7d", + "examples": ["7d"] + }, + "metrics_rotation_size": { + "type": "string", + "description": "The maximum file size before the metrics log is rotated in kilobytes, megabytes, or gigabytes, if applicable.", + "title": "Rotation Size of Metrics Files", + "default": "10M", + "examples": ["10M"] + }, + "syslog": { + "type": "object", + "description": "The syslog properties allow Pronghorn to send log messages to a local or remote syslog daemon.", + "properties": { + "level": { + "type": "string", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "host": { + "type": "string", + "description": "The host running syslogd.", + "title": "Host", + "default": "localhost", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "description": "The port on the host that syslog is running on.", + "title": "Port", + "default": 514, + "minimum": 1, + "maximum": 65535, + "examples": [514] + }, + "protocol": { + "type": "string", + "title": "Protocol", + "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", + "default": "udp4", + "examples": ["udp4"], + "enum": ["tcp4", "udp4", "unix", "unix-connect"] + }, + "facility": { + "type": "string", + "description": "Syslog facility to use.", + "title": "Facility", + "default": "local0", + "examples": ["local0"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", + "default": "BSD", + "examples": ["5424"], + "enum": ["BSD", "5424"] + }, + "path": { + "type": "string", + "title": "Path", + "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X).If path is used, host, port and protocol do not need to be configured.", + "default": "", + "format": "uri-reference", + "examples": ["/dev/log"] + }, + "pid": { + "type": "string", + "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", + "title": "Process Id", + "default": "process.pid", + "examples": ["process.pid"] + }, + "localhost": { + "type": "string", + "description": "Host to indicate that log messages are coming from.", + "title": "Log Host", + "default": "", + "examples": ["localhost"] + }, + "app_name": { + "type": "string", + "description": "The name of the application.", + "title": "Application Name", + "default": "", + "examples": ["process.title"] + }, + "eol": { + "type": "string", + "title": "End of Line Character", + "description": "The end of line character to be added to the end of the message.", + "default": "", + "examples": ["CR"] + } + }, + "allOf": [ + { + "required": ["level", "facility", "type"] + }, + { + "anyOf": [ + { + "required": ["host", "port", "protocol"] + }, + { + "required": ["path"] + } + ] + } + ], + "additionalProperties": false + } + }, + "required": [ + "log_max_files", + "log_max_file_size", + "log_level", + "log_directory", + "log_filename", + "console_level" + ], + "additionalProperties": false + }, + "isEncrypted": { + "type": "boolean", + "title": "isEncrypted", + "default": false, + "description": "Whether or not this service is encrypted", + "examples": [true, false] + }, + "profiling": { + "type": "boolean", + "title": "profiling", + "default": false, + "description": "Whether or not to profile this service", + "examples": [true, false] + }, + "model": { + "type": "string", + "title": "Model", + "default": "", + "description": "The model used by the service", + "examples": ["@itential/adapter-local_aaa"], + "pattern": "^@[-_.a-z]+/.+" + }, + "name": { + "type": "string", + "title": "Name", + "default": "", + "description": "The name of the service", + "pattern": "^[^\\/]+$", + "examples": ["Local AAA"] + }, + "type": { + "type": "string", + "title": "Type", + "default": "Application", + "description": "If the service is an app or adapter", + "enum": ["Application", "Adapter"] + }, + "properties": { + "type": "object", + "title": "Properties", + "description": "The properties of a service", + "properties": {} + }, + "virtual": { + "type": "boolean", + "title": "virtual", + "default": false, + "description": "Whether or not this service is an Integration.", + "examples": [true, false] + }, + "systemProps": { + "type": "object", + "title": "System Properties", + "description": "Properties used to configure IAP process.", + "properties": { + "maxOldSpaceSize": { + "type": "number", + "title": "maxOldSpaceSize", + "description": "Sets the limit heap memory size on service child process.", + "minimum": 100, + "examples": [2048, 1024] + } + } + }, + "eventDeduplication": { + "type": "object", + "title": "eventDeduplication", + "description": "Properties used by the event-system to deduplicate events", + "required": ["active", "cacheTtl", "uniqueProps"], + "properties": { + "active": { + "type": "boolean", + "description": "Whether or not event deduplication is configured", + "title": "Active" + }, + "cacheTtl": { + "type": "integer", + "description": "The time to live set up for event deduplication", + "title": "Cache Ttl", + "examples": [10000] + }, + "uniqueProps": { + "type": "array", + "description": "Unique properties set up in event deduplication", + "title": "Unique Props", + "items": { + "type": "string", + "examples": ["/messageId"] + } + } + } + } + }, + "oneOf": [ + { + "properties": { + "type": { + "const": "Application" + }, + "properties": { + "properties": {} + } + } + }, + { + "properties": { + "type": { + "const": "Adapter" + }, + "properties": { + "properties": { + "id": { + "type": "string", + "title": "id", + "default": "", + "description": "The id for the service", + "const": { + "$data": "2/name" + }, + "examples": ["Local AAA"] + }, + "type": { + "type": "string", + "title": "Type", + "default": "", + "description": "The type of service", + "examples": ["local_aaa"] + }, + "properties": { + "type": "object", + "properties": {} + }, + "brokers": { + "type": "array", + "uniqueItems": true, + "description": "Brokers which utilize this service", + "items": { + "type": "string", + "description": "Name of the broker", + "enum": [ + "aaa", + "compliance", + "device", + "fault", + "instance", + "inventory", + "method", + "notification", + "performance", + "persistence", + "service", + "topology" + ], + "examples": ["aaa"] + } + }, + "groups": { + "type": "array", + "description": "Groups which can use this service", + "items": { + "type": "string", + "description": "The mongo id of the group", + "examples": ["5fe9f10cc1fca243d562e1d8"], + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["id", "type", "properties", "brokers", "groups"] + } + } + } + ], + "required": [ + "loggerProps", + "isEncrypted", + "model", + "name", + "type", + "properties" + ], + "additionalProperties": false + }, + "iap_services-schema_log_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "iap_services-schema_sys_log_level": { + "type": "string", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "iap_services-schema_name": { + "type": "string", + "title": "Name", + "default": "", + "description": "The name of the service", + "pattern": "^[^\\/]+$", + "examples": ["Local AAA"] + }, + "iap_services-schema_model": { + "type": "string", + "title": "Model", + "default": "", + "description": "The model used by the service", + "examples": ["@itential/adapter-local_aaa"], + "pattern": "^@[-_.a-z]+/.+" + }, + "iap_services-schema_isEncrypted": { + "type": "boolean", + "title": "isEncrypted", + "default": false, + "description": "Whether or not this service is encrypted", + "examples": [true, false] + }, + "iap_services-schema_type": { + "type": "string", + "title": "Type", + "default": "Application", + "description": "If the service is an app or adapter", + "enum": ["Application", "Adapter"] + }, + "iap_services-schema_loggerProps": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description property", + "title": "Description", + "default": "Logger Settings", + "examples": ["Logging"] + }, + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store Pronghorn log files.", + "default": "/var/log/pronghorn", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name of the current Pronghorn log file.", + "title": "Filename", + "default": "pronghorn.log", + "examples": ["pronghorn.log"] + }, + "log_max_file_size": { + "type": "integer", + "title": "Max File Size", + "description": "The maximum size of each Pronghorn log file in bytes.", + "default": 1048576, + "examples": [1048576] + }, + "log_max_files": { + "type": "integer", + "description": "The maximum number of log files maintained on the server.", + "title": "Max Number of Files", + "default": 100, + "examples": [100] + }, + "log_timezone_offset": { + "type": "integer", + "description": "An integer specifying the offset from GMT/UTC time that will be used when writing to the log files.", + "title": "Timezone Offset", + "default": 0, + "examples": [-5], + "minimum": -12, + "maximum": 12 + }, + "log_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "console_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "metrics_filename": { + "type": "string", + "description": "The name of the job metrics log file, if applicable.", + "title": "Metrics Filename", + "default": "metrics.log", + "examples": ["metrics.log"] + }, + "metrics_max_files": { + "type": "integer", + "description": "The maximum number of job metrics log files maintained on the server, if applicable.", + "title": "Max Number of Metrics Files", + "default": 31, + "examples": [31] + }, + "metrics_rotation_interval": { + "type": "string", + "description": "The time until the metrics log is rotated in minutes, hours, days, or weeks, if applicable.", + "title": "Rotation Interval of Metrics Files", + "default": "7d", + "examples": ["7d"] + }, + "metrics_rotation_size": { + "type": "string", + "description": "The maximum file size before the metrics log is rotated in kilobytes, megabytes, or gigabytes, if applicable.", + "title": "Rotation Size of Metrics Files", + "default": "10M", + "examples": ["10M"] + }, + "syslog": { + "type": "object", + "description": "The syslog properties allow Pronghorn to send log messages to a local or remote syslog daemon.", + "properties": { + "level": { + "type": "string", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "host": { + "type": "string", + "description": "The host running syslogd.", + "title": "Host", + "default": "localhost", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "description": "The port on the host that syslog is running on.", + "title": "Port", + "default": 514, + "minimum": 1, + "maximum": 65535, + "examples": [514] + }, + "protocol": { + "type": "string", + "title": "Protocol", + "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", + "default": "udp4", + "examples": ["udp4"], + "enum": ["tcp4", "udp4", "unix", "unix-connect"] + }, + "facility": { + "type": "string", + "description": "Syslog facility to use.", + "title": "Facility", + "default": "local0", + "examples": ["local0"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", + "default": "BSD", + "examples": ["5424"], + "enum": ["BSD", "5424"] + }, + "path": { + "type": "string", + "title": "Path", + "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X).If path is used, host, port and protocol do not need to be configured.", + "default": "", + "format": "uri-reference", + "examples": ["/dev/log"] + }, + "pid": { + "type": "string", + "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", + "title": "Process Id", + "default": "process.pid", + "examples": ["process.pid"] + }, + "localhost": { + "type": "string", + "description": "Host to indicate that log messages are coming from.", + "title": "Log Host", + "default": "", + "examples": ["localhost"] + }, + "app_name": { + "type": "string", + "description": "The name of the application.", + "title": "Application Name", + "default": "", + "examples": ["process.title"] + }, + "eol": { + "type": "string", + "title": "End of Line Character", + "description": "The end of line character to be added to the end of the message.", + "default": "", + "examples": ["CR"] + } + }, + "allOf": [ + { + "required": ["level", "facility", "type"] + }, + { + "anyOf": [ + { + "required": ["host", "port", "protocol"] + }, + { + "required": ["path"] + } + ] + } + ], + "additionalProperties": false + } + }, + "required": [ + "log_max_files", + "log_max_file_size", + "log_level", + "log_directory", + "log_filename", + "console_level" + ], + "additionalProperties": false + }, + "iap_services-schema_properties": { + "type": "object", + "title": "Properties", + "description": "The properties of a service", + "properties": {} + }, + "iap_services-schema_virtual": { + "type": "boolean", + "title": "virtual", + "default": false, + "description": "Whether or not this service is an Integration.", + "examples": [true, false] + }, + "iap_banner-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "The root schema", + "description": "The root schema comprises the entire JSON document.", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "active": { + "type": "boolean", + "description": "A flag indicating if the banner will be displayed to users" + }, + "text": { + "type": "string", + "description": "Text in the banner when displayed" + }, + "backgroundColor": { + "type": "string", + "description": "The background color for the banner displayed", + "examples": ["#fff"] + }, + "dismissible": { + "type": "boolean", + "description": "A flag indicating if a banner should be dismissible by users" + }, + "startTime": { + "type": "string", + "description": "An ISO Timestring value indicating when the banner will show", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "endTime": { + "type": "string", + "description": "A, ISO Timestring value indicating when the banner will no longer show", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "allPages": { + "type": "boolean", + "description": "A flag indicating if the banner should show on all pages or only the IAP home page" + }, + "image": { + "description": "A base64 image string containing the image that will be shown on the banner", + "type": "string" + }, + "messageLastUpdated": { + "type": "string", + "description": "An ISO Timestring value indicating when the banner message was last updated", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", + "examples": ["2018-08-02T15:56:12.912Z"] + } + }, + "required": ["text", "active", "startTime", "dismissible", "allPages"] + }, + "iap_authorization-common": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Common Authorization Schema" + }, + "iap_authorization-common_accounts-query": { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["john_doe"] + }, + "firstname": { + "type": "string", + "examples": ["John"] + }, + "email": { + "type": "string", + "examples": ["user@email.com"] + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + } + } + }, + "iap_authorization-common_groups-query": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["group1"] + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "description": { + "type": "string", + "examples": ["this is group1"] + } + } + }, + "iap_authorization-common_roles-query": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "examples": ["Custom"] + }, + "name": { + "type": "string", + "examples": ["role_1"] + }, + "description": { + "type": "string", + "examples": ["description of role_1"] + } + } + }, + "iap_authorization-common_roleId": { + "title": "roleId", + "type": "string", + "examples": ["Authorization.admin"] + }, + "iap_groups-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Group Schema", + "description": "This is the schema for an IAP group stored in Mongo", + "properties": { + "provenance": { + "title": "Provenance", + "description": "AAA provider where group originated", + "type": "string", + "examples": ["Local AAA", "Pronghorn"] + }, + "name": { + "title": "Name", + "description": "Name of group", + "type": "string", + "examples": ["group_1"] + }, + "description": { + "title": "Description", + "description": "Description of group", + "type": "string", + "examples": ["description of group_1"] + }, + "memberOf": { + "title": "Assigned Groups", + "description": "Parent groups which this group is a part of", + "type": "array", + "items": { + "type": "object", + "properties": { + "aaaManaged": { + "description": "Whether group comes from an external AAA or not", + "type": "boolean" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "assignedRoles": { + "title": "Assigned Roles", + "description": "Roles assigned to this group", + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + }, + "additionalProperties": false + } + }, + "inactive": { + "title": "Inactive", + "description": "Setting for whether group is active or not", + "type": "boolean" + }, + "_meta": { + "title": "Metadata", + "description": "Metadata for group", + "type": "object", + "properties": { + "created": { + "title": "Created", + "description": "When the group was created", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updated": { + "title": "Updated", + "description": "When the group was last updated", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + } + } + } + }, + "additionalProperties": false, + "required": [ + "provenance", + "name", + "description", + "memberOf", + "assignedRoles", + "inactive" + ] + }, + "iap_groups-schema_inactive": { + "title": "Inactive", + "description": "Setting for whether group is active or not", + "type": "boolean" + }, + "iap_groups-schema_provenance": { + "title": "Provenance", + "description": "AAA provider where group originated", + "type": "string", + "examples": ["Local AAA", "Pronghorn"] + }, + "iap_groups-schema_name": { + "title": "Name", + "description": "Name of group", + "type": "string", + "examples": ["group_1"] + }, + "iap_groups-schema_description": { + "title": "Description", + "description": "Description of group", + "type": "string", + "examples": ["description of group_1"] + }, + "iap_groups-schema_memberOf": { + "title": "Assigned Groups", + "description": "Parent groups which this group is a part of", + "type": "array", + "items": { + "type": "object", + "properties": { + "aaaManaged": { + "description": "Whether group comes from an external AAA or not", + "type": "boolean" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "iap_groups-schema_assignedRoles": { + "title": "Assigned Roles", + "description": "Roles assigned to this group", + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + }, + "additionalProperties": false + } + }, + "iap_roles-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Role Schema", + "description": "This is the schema for an IAP role stored in Mongo", + "properties": { + "provenance": { + "type": "string", + "examples": ["Custom"] + }, + "name": { + "type": "string", + "examples": ["role_1"] + }, + "description": { + "type": "string", + "examples": ["description of role_1"] + }, + "allowedMethods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["methodName"] + }, + "provenance": { + "type": "string", + "examples": ["ApplicationName"] + } + } + } + }, + "allowedViews": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/manual/task/path"] + }, + "provenance": { + "type": "string", + "examples": ["ApplicationName"] + } + } + } + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updated": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + } + } + } + }, + "additionalProperties": false, + "required": [ + "provenance", + "name", + "description", + "allowedMethods", + "allowedViews" + ] + }, + "iap_roles-schema_name": { + "type": "string", + "examples": ["role_1"] + }, + "iap_roles-schema_description": { + "type": "string", + "examples": ["description of role_1"] + }, + "iap_roles-schema_allowedMethods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["methodName"] + }, + "provenance": { + "type": "string", + "examples": ["ApplicationName"] + } + } + } + }, + "iap_roles-schema_allowedViews": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/manual/task/path"] + }, + "provenance": { + "type": "string", + "examples": ["ApplicationName"] + } + } + } + }, + "iap_system-common": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Common System Schema" + }, + "iap_system-common_methods-query": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["getAdapters"] + }, + "provenance": { + "type": "string", + "examples": ["Adapters"] + }, + "deprecated": { + "type": "boolean" + } + } + }, + "iap_system-common_views-query": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/"] + }, + "provenance": { + "type": "string", + "examples": ["WorkFlowEngine"] + } + } + }, + "iap_device-count-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Device Count History Schema", + "description": "This is the schema for an IAP device count stored in Mongo", + "properties": { + "timestamp": { + "type": "string", + "description": "An ISODate representing when the device count was taken", + "examples": ["2023-02-14T20:06:50.569Z"] + }, + "serverId": { + "type": "string", + "description": "The serverId where the device count was taken" + }, + "counts": { + "type": "object", + "description": "The key/value pair between an adapter name and the number of devices", + "additionalProperties": { + "type": "integer", + "minimum": 0 + } + } + }, + "required": ["timestamp", "serverId", "counts"], + "additionalProperties": false + }, + "iap_services-health-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "The root schema", + "description": "The root schema comprises the entire JSON document.", + "properties": { + "id": { + "type": "string", + "examples": ["AdminEssentials"] + }, + "package_id": { + "type": "string", + "title": "Model", + "default": "", + "description": "The model used by the service", + "examples": ["@itential/adapter-local_aaa"], + "pattern": "^@[-_.a-z]+/.+" + }, + "version": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + }, + "type": { + "type": "string", + "enum": ["Adapter", "Application"] + }, + "description": { + "type": "string", + "examples": ["A basic description"] + }, + "state": { + "type": "string", + "enum": ["DEAD", "STOPPED", "RUNNING", "DELETED"] + }, + "connection": { + "type": "object", + "oneOf": [ + { + "const": null + }, + { + "properties": { + "state": { + "type": "string", + "examples": ["ONLINE"] + } + } + } + ] + }, + "uptime": { + "type": "number", + "description": "Number of seconds the current process has been running.", + "examples": [2245.9722] + }, + "memoryUsage": { + "type": "object", + "properties": { + "rss": { + "type": "integer", + "description": "Resident Set Size - the amount of space occupied in the main memory - in bytes", + "examples": [7125982] + }, + "heapTotal": { + "type": "integer", + "description": "Heap Total in bytes for the Node V8 engine", + "examples": [7125982] + }, + "heapUsed": { + "type": "integer", + "description": "Heap Used in bytes by the Node V8 engine", + "examples": [7125982] + }, + "external": { + "type": "integer", + "description": "External usage - memory usage of C++ objects bound to JavaScript objects managed by the Node V8 engine - in bytes", + "examples": [7125982] + } + } + }, + "cpuUsage": { + "type": "object", + "description": "Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)", + "properties": { + "user": { + "description": "Microseconds spent in user mode", + "type": "integer", + "examples": [7125982] + }, + "system": { + "description": "Microseconds spent in system mode", + "type": "integer", + "examples": [7125982] + } + } + }, + "pid": { + "type": "integer", + "examples": [7125982] + }, + "logger": { + "type": "object", + "properties": { + "console": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "file": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "syslog": { + "type": "string", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + } + } + }, + "routePrefix": { + "type": "string", + "examples": ["admin", "search"] + }, + "prevUptime": { + "type": "number", + "examples": [2245.9722] + } + } + }, + "iap_services-health-schema_version": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + }, + "iap_services-health-schema_cpuUsage": { + "type": "object", + "description": "Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)", + "properties": { + "user": { + "description": "Microseconds spent in user mode", + "type": "integer", + "examples": [7125982] + }, + "system": { + "description": "Microseconds spent in system mode", + "type": "integer", + "examples": [7125982] + } + } + }, + "iap_services-health-schema_uptime": { + "type": "number", + "description": "Number of seconds the current process has been running.", + "examples": [2245.9722] + }, + "iap_services-health-schema_pid": { + "type": "integer", + "examples": [7125982] + }, + "iap_services-health-schema_memoryUsage": { + "type": "object", + "properties": { + "rss": { + "type": "integer", + "description": "Resident Set Size - the amount of space occupied in the main memory - in bytes", + "examples": [7125982] + }, + "heapTotal": { + "type": "integer", + "description": "Heap Total in bytes for the Node V8 engine", + "examples": [7125982] + }, + "heapUsed": { + "type": "integer", + "description": "Heap Used in bytes by the Node V8 engine", + "examples": [7125982] + }, + "external": { + "type": "integer", + "description": "External usage - memory usage of C++ objects bound to JavaScript objects managed by the Node V8 engine - in bytes", + "examples": [7125982] + } + } + }, + "iap_links-query": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential External Link Query Schema", + "description": "This is the schema for queries on IAP external links", + "properties": { + "name": { + "type": "string", + "examples": ["Google"] + }, + "address": { + "type": "string", + "examples": ["https://www.google.com/"] + }, + "description": { + "type": "string", + "examples": ["A link to Google"] + } + }, + "additionalProperties": false + }, + "iap_links-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential External Link Schema", + "description": "This is the schema for an IAP external link stored in Mongo", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "pattern": "^(?![\\s.]+$)[a-zA-Z\\s.]*$", + "examples": ["Google"] + }, + "address": { + "type": "string", + "minLength": 1, + "examples": ["https://www.google.com/"] + }, + "description": { + "type": "string", + "examples": ["A link to Google"] + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updated": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + } + } + } + }, + "required": ["name", "address"], + "additionalProperties": false + }, + "iap_links-schema_name": { + "type": "string", + "minLength": 1, + "pattern": "^(?![\\s.]+$)[a-zA-Z\\s.]*$", + "examples": ["Google"] + }, + "iap_links-schema_address": { + "type": "string", + "minLength": 1, + "examples": ["https://www.google.com/"] + }, + "iap_links-schema_description": { + "type": "string", + "examples": ["A link to Google"] + }, + "iap_repository-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Prebuilt Repository Configuration Schema", + "description": "This is the schema for a Repository Configuration used to fetch Prebuilts", + "properties": { + "enabled": {}, + "type": {}, + "hostname": {}, + "path": {}, + "credentials": {}, + "versionStatus": { + "type": "string", + "description": "The version status of the Pre-built Automation in relation to the current IAP version", + "enum": ["current", "latest"], + "default": "latest" + } + }, + "required": ["enabled", "type", "hostname", "path", "credentials"], + "additionalProperties": false + }, + "iap_repository-schema_enabled": { + "type": "boolean", + "description": "A flag that denotes if the repository configuration is connected", + "enum": [true, false] + }, + "iap_repository-schema_type": { + "type": "string", + "description": "The type of Repository", + "enum": ["gitlab"] + }, + "iap_repository-schema_hostname": { + "type": "string", + "description": "The hostname of the Respository endpoint", + "examples": ["gitlab.com"] + }, + "iap_repository-schema_path": { + "type": "string", + "description": "The path of the Repository endpoint", + "examples": ["itentialopensource/pre-built-automations"] + }, + "iap_repository-schema_credentials": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "An access token used to make HTTP requests", + "examples": ["uTc_P4pnMAEsLbQHmyOt"] + } + }, + "additionalProperties": false + }, + "iap_sso-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "SSO Schema", + "description": "Schema describing an SSO configuration object", + "properties": { + "name": { + "type": "string", + "description": "Name of the SSO configuration", + "examples": ["Auth0", "Okta"] + }, + "ssoType": { + "type": "string", + "description": "Single sign on type, SAML, OpenID, etc.", + "examples": ["saml"], + "enum": ["saml"] + }, + "settings": { + "type": "object", + "description": "The configuration for the sso type used", + "oneOf": [ + { + "type": "object", + "required": [ + "issuer", + "loginURL", + "certificate", + "samlUserNameAttribute", + "samlGroupsAttribute", + "forceLogin" + ], + "additionalProperties": false, + "properties": { + "description": { + "type": "string", + "description": "A description of the sso configuration", + "examples": ["This sso configuration connects to Okta"] + }, + "issuer": { + "type": "string", + "description": "Issuer identity provider", + "examples": ["https://www.auth0.com/oauth2/example"] + }, + "loginURL": { + "type": "string", + "description": "Login URL for SSO identity provider", + "examples": ["https://www.auth0.com/login"] + }, + "logoutURL": { + "type": "string", + "description": "Logout URL for SSO identity provider", + "examples": ["https://www.auth0.com/logout"] + }, + "certificate": { + "type": "string", + "description": "Security certificate", + "examples": [ + "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==" + ] + }, + "samlEmailAttribute": { + "type": "string", + "description": "Attribute containing user email address", + "examples": [ + "mail", + "email", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ], + "default": "email" + }, + "samlUserNameAttribute": { + "type": "string", + "description": "Attribute containing the full user name", + "examples": [ + "userName", + "user", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" + ], + "default": "username" + }, + "samlGroupsAttribute": { + "type": "string", + "description": "Attribute containing the name of the groups property", + "examples": [ + "groups", + "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups" + ], + "default": "groups" + }, + "samlFirstNameAttribute": { + "type": "string", + "description": "Attribute containing the first name of the user", + "examples": [ + "firstName", + "name", + "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" + ] + }, + "forceLogin": { + "type": "boolean", + "description": "A boolean flag indicating if a user is forced to login", + "title": "Force User Login", + "default": false + } + } + } + ] + }, + "active": { + "description": "Whether or not the SSO Config is selected for use. For 'active' to be true, 'tested' must also be true.", + "type": "boolean", + "default": false + }, + "tested": { + "type": "boolean", + "description": "Whether the sso config was tested" + } + }, + "required": ["name", "ssoType", "settings"], + "additionalProperties": false + }, + "iap_sso-schema_samlConfig": { + "type": "object", + "required": [ + "issuer", + "loginURL", + "certificate", + "samlUserNameAttribute", + "samlGroupsAttribute", + "forceLogin" + ], + "additionalProperties": false, + "properties": { + "description": { + "type": "string", + "description": "A description of the sso configuration", + "examples": ["This sso configuration connects to Okta"] + }, + "issuer": { + "type": "string", + "description": "Issuer identity provider", + "examples": ["https://www.auth0.com/oauth2/example"] + }, + "loginURL": { + "type": "string", + "description": "Login URL for SSO identity provider", + "examples": ["https://www.auth0.com/login"] + }, + "logoutURL": { + "type": "string", + "description": "Logout URL for SSO identity provider", + "examples": ["https://www.auth0.com/logout"] + }, + "certificate": { + "type": "string", + "description": "Security certificate", + "examples": [ + "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==" + ] + }, + "samlEmailAttribute": { + "type": "string", + "description": "Attribute containing user email address", + "examples": [ + "mail", + "email", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ], + "default": "email" + }, + "samlUserNameAttribute": { + "type": "string", + "description": "Attribute containing the full user name", + "examples": [ + "userName", + "user", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" + ], + "default": "username" + }, + "samlGroupsAttribute": { + "type": "string", + "description": "Attribute containing the name of the groups property", + "examples": [ + "groups", + "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups" + ], + "default": "groups" + }, + "samlFirstNameAttribute": { + "type": "string", + "description": "Attribute containing the first name of the user", + "examples": [ + "firstName", + "name", + "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" + ] + }, + "forceLogin": { + "type": "boolean", + "description": "A boolean flag indicating if a user is forced to login", + "title": "Force User Login", + "default": false + } + } + }, + "iap_mapping-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Group Mapping Schema", + "description": "This is the schema for an IAP group mapping stored in Mongo", + "properties": { + "externalGroup": { + "type": "string", + "description": "name of the external group" + }, + "provenance": { + "type": "string", + "description": "The AAA provider for the external group", + "examples": ["Okta"] + }, + "iapGroups": { + "type": "array", + "items": { + "type": "string", + "description": "ObjectId for the group within IAP" + } + } + }, + "required": ["externalGroup", "iapGroups", "provenance"], + "additionalProperties": false + }, + "iap_mapping-schema_iapGroups": { + "type": "array", + "items": { + "type": "string", + "description": "ObjectId for the group within IAP" + } + }, + "iap_mapping-schema_externalGroup": { + "type": "string", + "description": "name of the external group" + }, + "iap_mapping-schema_provenance": { + "type": "string", + "description": "The AAA provider for the external group", + "examples": ["Okta"] + }, + "iap_git-common": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Common Git Schema" + }, + "iap_git-common_type": { + "type": "string", + "description": "The type of Git provider being used", + "enum": ["GitHub", "GitLab"] + }, + "iap_git-common_repoPath": { + "title": "repoPath", + "description": "The path in Git to the repository", + "type": "string", + "examples": ["github-organization", "gitlabGroup%2FsubGroup"] + }, + "iap_git-common_branchName": { + "title": "branchName", + "description": "The name of the branch inside a Git repository", + "type": "string", + "examples": ["main"] + }, + "iap_git-common_projectPath": { + "title": "repoPath", + "description": "The file path within a Git repository to a project file", + "type": "string", + "examples": ["directory%2Fproject.json", "example.json"] + }, + "iap_git-common_commitMessage": { + "title": "commitMessage", + "description": "The commit message sent to Git when updating a project", + "type": "string", + "examples": ["This is an example commit message."] + }, + "iap_service-accounts-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential OAuth Service Account Schema", + "description": "This is the schema for an OAuth service account stored in Mongo", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "name": { + "type": "string", + "description": "The name associated with the service account", + "examples": ["ExampleName"] + }, + "description": { + "type": "string", + "description": "The description of the service account", + "examples": [ + "This is a service account for the external Example system" + ] + }, + "clientId": {}, + "clientSecret": { + "type": "string", + "description": "Uuid representation of client secret", + "examples": ["d4c673d6-17f8-4e76-8034-a87820f96618"] + }, + "_meta": { + "type": "object", + "properties": { + "updated": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updatedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "created": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "additionalProperties": false, + "required": ["name", "description", "clientId", "clientSecret"] + }, + "iap_service-accounts-schema_name": { + "type": "string", + "description": "The name associated with the service account", + "examples": ["ExampleName"] + }, + "iap_service-accounts-schema_description": { + "type": "string", + "description": "The description of the service account", + "examples": [ + "This is a service account for the external Example system" + ] + }, + "iap_service-accounts-schema_clientId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "iap_service-accounts-schema_clientSecret": { + "type": "string", + "description": "Uuid representation of client secret", + "examples": ["d4c673d6-17f8-4e76-8034-a87820f96618"] + }, + "iap_service-accounts-schema_modifiedByDereferenced": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "username": { + "type": "string", + "examples": ["username@itential"] + } + } + }, + "iap_service-accounts-schema_timestamp": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "formbuilder_formDocument": { + "title": "form document", + "description": "A form document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + "name": { + "type": "string", + "examples": ["Form 123"] + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time" + }, + "created_by": {}, + "last_updated": { + "type": "string", + "format": "date-time" + }, + "last_updated_by": {}, + "elements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["service_model"] + }, + "id": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["/ncs:services/test_devices:service_name"] + } + }, + "required": ["name"] + } + }, + "required": ["type", "id"] + }, + "examples": [ + [ + { + "type": "method", + "id": { + "name": "method_name_1" + } + } + ] + ] + }, + "children": { + "type": "array", + "items": { + "type": "object", + "required": ["properties", "id", "type"], + "properties": { + "id": { + "type": "string", + "oneOf": [ + { + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + { + "pattern": "cont-." + } + ] + }, + "element": { + "type": "string", + "examples": [ + "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}" + ] + }, + "type": { + "type": "string", + "examples": ["container"] + }, + "name": { + "type": "string", + "examples": ["vlan_id_123"] + }, + "display_name": { + "type": "string", + "examples": ["vlan"] + }, + "source_type": { + "type": "string", + "enum": ["service_model", "custom", "method"] + }, + "source": { + "type": "string", + "examples": ["/ncs:services/abc_devices:ios.device"] + }, + "key": { + "type": "string", + "examples": [ + "service.vlanid", + "key_545385c3-fc66-491b-bf6f-abc2214366dc" + ] + }, + "properties": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["leafref"] + }, + "path": { + "type": "string", + "examples": ["/ncs:devices/ncs:device/ncs:name"] + }, + "min": { + "anyOf": [ + { + "type": "string", + "examples": ["1"] + }, + { + "type": "integer", + "examples": [1] + }, + { + "type": "null" + } + ] + }, + "max": { + "anyOf": [ + { + "type": "string", + "examples": ["4"] + }, + { + "type": "integer", + "examples": [1] + }, + { + "type": "null" + } + ] + }, + "minLength": { + "anyOf": [ + { + "type": "string", + "examples": ["1"] + }, + { + "type": "integer", + "examples": [1] + }, + { + "type": "null" + } + ] + }, + "maxLength": { + "anyOf": [ + { + "type": "string", + "examples": ["4"] + }, + { + "type": "integer", + "examples": [1] + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "direction": { + "type": "string", + "examples": ["vertical"] + }, + "required": { + "type": "boolean" + }, + "enforce": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + } + } + } + }, + "examples": [ + { + "type": "field", + "name": "ipaddress", + "properties": { + "type": "string", + "prefix": "" + }, + "description": "IP address", + "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}", + "source_type": "method", + "source": "method_name_1", + "id": "a40044c2-f378-4b2b-a81a-41d78979e583", + "yangkey": "", + "key": "method_name_1.ipAddress" + } + ] + } + } + }, + "required": ["name", "children", "elements"] + }, + "formbuilder_formDocument_formName": { + "type": "string", + "examples": ["Form 123"] + }, + "formbuilder_formDocument_ObjectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formbuilder_formDocument_uuidv4": { + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + "formbuilder_formDocument_groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "formbuilder_formDocument_elements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["service_model"] + }, + "id": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["/ncs:services/test_devices:service_name"] + } + }, + "required": ["name"] + } + }, + "required": ["type", "id"] + }, + "examples": [ + [ + { + "type": "method", + "id": { + "name": "method_name_1" + } + } + ] + ] + }, + "search_searchResults": { + "title": "search results", + "description": "The results of a search", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "examples": [ + "Forms", + "The Title of the Application the result came from." + ] + }, + "type": { + "type": "string", + "examples": [ + "forms", + "The name of the Collection the result came from" + ] + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": [ + "912fd926-5391-48ff-b265-394d00640f4f", + "The id of the result." + ] + }, + "name": { + "type": "string", + "examples": ["testForm", "Name of the result."] + }, + "description": { + "type": "string", + "examples": [ + "Hi I describe the result", + "Description for the result is optional." + ] + }, + "url": { + "type": "string", + "examples": [ + "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f", + "The shortened url to access the result from." + ] + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": [ + "5c8fa4a8d8e04500b1b2f28f", + "The id of the tag." + ] + }, + "description": { + "type": "string", + "examples": [ + "Hi I describe the tag", + "Description for the tag is optional." + ] + }, + "name": { + "type": "string", + "examples": ["testTag", "Name of the tag."] + } + } + } + } + } + } + }, + "count": { + "type": "integer" + } + } + } + } + } + }, + "configuration_manager_common_mongoObjectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "configuration_manager_common_timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "configuration_manager_common_standardName": { + "type": "string", + "examples": ["my standard name"], + "minLength": 1 + }, + "configuration_manager_common_standardDescription": { + "type": "string", + "examples": ["my standard description"], + "minLength": 1 + }, + "configuration_manager_common_multiElementString": { + "type": "string", + "examples": ["device1, device2, device3, device4"], + "minLength": 1 + }, + "configuration_manager_deviceData_deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "configuration_manager_deviceData_deviceDetails": { + "title": "deviceDetails", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["xr9kv01-aws"] + }, + "authgroup": { + "type": "string", + "examples": ["xr9kv-aws"] + }, + "ipaddress": { + "type": "string", + "examples": ["10.1.6.100"] + }, + "address": { + "type": "string", + "examples": ["10.1.6.100"] + }, + "port": { + "type": "string", + "examples": ["22"] + }, + "device-type": { + "type": "string", + "examples": ["cli"] + }, + "ostype": { + "type": "string", + "examples": ["cisco-ios-xr"] + }, + "ned": { + "type": "string", + "examples": ["cisco-ios-xr"] + }, + "admin": { + "type": "boolean" + }, + "host": { + "type": "string", + "examples": ["nso46"] + }, + "actions": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "addDevice", + "addDeviceGroup", + "addDeviceToGroup", + "addToAuthGroup", + "applyTemplate", + "applyTemplates", + "applyVariableTemplate", + "checkSync", + "checkSyncDevices", + "isAlive", + "deleteDevice", + "deleteDeviceGroup", + "dryRunVariableTemplate", + "getAuthGroups", + "getConfig", + "getDevice", + "getDeviceGroups", + "getDeviceGroupsForDevices", + "getDevices", + "getDevicesFiltered", + "getNEDs", + "getOutOfSyncConfig", + "getTemplates", + "liveStatus", + "passThru", + "pingDevice", + "removeDeviceFromGroup", + "restoreDevice", + "runAction", + "runCommand", + "setConfig", + "syncFrom", + "syncFromDevices", + "syncTo", + "syncToDevices", + "turnUpDevice", + "verifyConfig" + ] + }, + "uniqueItems": true + }, + "origins": { + "type": "array", + "items": { + "type": "string", + "examples": ["nso46"] + } + } + }, + "required": [ + "name", + "device-type", + "ipaddress", + "port", + "ostype", + "host", + "actions", + "origin" + ] + }, + "configuration_manager_deviceData_deviceConfigurationFormat": { + "title": "format", + "type": "string", + "enum": ["native", "xml", "json"], + "examples": ["native"] + }, + "configuration_manager_deviceData_deviceConfiguration": { + "title": "config", + "type": "object", + "properties": { + "device": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "config": { + "type": "string", + "examples": ["hostname ios0\nno service password-encryption\n..."] + } + } + }, + "configuration_manager_deviceData_deviceConfigurationString": { + "type": "string", + "examples": ["hostname ios0\nno service password-encryption\n..."] + }, + "configuration_manager_deviceData_backupDescription": { + "type": "string", + "examples": ["description of backup"] + }, + "configuration_manager_deviceData_backupNotes": { + "type": "string", + "examples": ["notes about backup"] + }, + "configuration_manager_deviceData_backup": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "provider": { + "type": "string" + }, + "type": { + "title": "format", + "type": "string", + "enum": ["native", "xml", "json"], + "examples": ["native"] + }, + "date": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "rawConfig": { + "type": "string", + "examples": ["hostname ios0\nno service password-encryption\n..."] + }, + "description": { + "type": "string", + "examples": ["description of backup"] + }, + "notes": { + "type": "string", + "examples": ["notes about backup"] + }, + "gbac": { + "type": "object", + "description": "Sets of group Ids that are allowd to access this automation.", + "properties": { + "write": { + "type": "array", + "description": "Group ids that have write access to the automation document.", + "items": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + }, + "read": { + "type": "array", + "description": "Group ids that have read access to the automation document.", + "items": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + }, + "required": ["write", "read"] + } + } + }, + "configuration_manager_deviceGroupDocument": { + "$schema": "http://json-schema.org/draft-07/schema#", + "description": "A group of devices that are referenced by name only", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string", + "examples": ["my standard name"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["my standard description"], + "minLength": 1 + }, + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + } + }, + "additionalProperties": true + }, + "configuration_manager_deviceGroupDocument_groupDetails": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["my standard name"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["my standard description"], + "minLength": 1 + }, + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + } + }, + "required": ["name"], + "additionalProperties": false + }, + "configuration_manager_deviceGroupDocument_updateGroupDetails": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["my standard name"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["my standard description"], + "minLength": 1 + }, + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + } + }, + "additionalProperties": false + }, + "configuration_manager_deviceGroupDocument_createGroupResponseWithName": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string" + }, + "message": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "required": ["id", "name", "message", "status"] + }, + "configuration_manager_deviceGroupDocument_updateGroupsResponse": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "modified": { + "type": "number" + } + }, + "required": ["status", "modified"] + }, + "configuration_manager_deviceGroupDocument_deleteGroupResponse": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "deleted": { + "type": "number" + } + }, + "required": ["status", "deleted"] + }, + "configuration_manager_goldenConfigData_goldenConfigNodePath": { + "title": "goldenConfigNodePath", + "type": "string", + "examples": ["base", "base/US East", "base/US East/Atlanta"] + }, + "configuration_manager_goldenConfigData_goldenConfigTreeVersionName": { + "title": "goldenConfigTreeVersionName", + "type": "string", + "examples": ["initial", "v2", "v3", "draft-v4"] + }, + "configuration_manager_goldenConfigData_goldenConfigNode": { + "title": "goldenConfigNode", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["base", "us-east", "edge"] + }, + "attributes": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "children": { + "type": "array", + "items": { + "title": "goldenConfigNode", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["base", "us-east", "edge"] + }, + "attributes": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "children": { + "type": "array", + "items": {} + } + }, + "required": ["name", "attributes", "children"] + } + } + }, + "required": ["name", "attributes", "children"] + }, + "configuration_manager_goldenConfigData_goldenConfigTreeVersion": { + "title": "goldenConfigTreeVersion", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string", + "examples": [ + "Cisco Edge - Day 0", + "Cisco Edge - Day 1", + "Cisco Core - Day 0", + "Cisco Core - Day 1" + ] + }, + "deviceType": { + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "version": { + "type": "string", + "examples": ["initial", "v2", "v3", "draft v4"] + }, + "root": { + "title": "goldenConfigNode", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["base", "us-east", "edge"] + }, + "attributes": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "children": { + "type": "array", + "items": {} + } + }, + "required": ["name", "attributes", "children"] + }, + "variables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["variable name"] + }, + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["variable value"] + } + } + } + }, + "created": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "lastUpdated": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "lastUpdatedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary": { + "title": "goldenConfigTreeVersion", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string", + "examples": [ + "Cisco Edge - Day 0", + "Cisco Edge - Day 1", + "Cisco Core - Day 0", + "Cisco Core - Day 1" + ] + }, + "deviceType": { + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "versions": { + "type": "array", + "items": { + "type": "string", + "examples": ["initial", "v2", "v3", "draft v4"] + } + }, + "created": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "lastUpdated": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigSpecWord": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigSpecLineId": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "configuration_manager_goldenConfigData_goldenConfigSpecLine": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": ["required", "disallowed", "ignored", "optional"] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": ["required", "disallowed", "ignored", "optional"] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigSpec": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "deviceType": { + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "lines": { + "type": "array", + "items": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": ["required", "disallowed", "ignored", "optional"] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": {} + } + } + } + }, + "created": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "lastUpdated": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "lastUpdatedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigJSONSpec": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "deviceType": { + "type": "string", + "examples": ["json"] + }, + "data": { + "type": "object", + "properties": {} + }, + "created": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "lastUpdated": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "lastUpdatedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigVariables": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["variable name"] + }, + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["variable value"] + } + } + } + }, + { + "type": "object", + "properties": {}, + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["string value", "^regular.*expression$"] + } + } + }, + { + "type": "string", + "examples": ["string value"] + } + ] + } + } + ] + }, + "configuration_manager_goldenConfigData_reportGradingOptions": { + "type": "object", + "properties": { + "weights": { + "type": "object", + "properties": { + "error": { + "type": "number" + }, + "warning": { + "type": "number" + }, + "info": { + "type": "number" + } + } + }, + "benchmarks": { + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "number" + } + } + } + }, + "configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions": { + "type": "object", + "properties": { + "weights": { + "type": "object", + "properties": { + "error": { + "type": "number" + }, + "warning": { + "type": "number" + }, + "info": { + "type": "number" + } + } + }, + "benchmarks": { + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "number" + } + }, + "limit": { + "type": "integer", + "minimum": 1 + } + } + }, + "configuration_manager_goldenConfigData_complianceSummary": { + "title": "complianceSummary", + "type": "object", + "properties": { + "errors": { + "type": "integer", + "minimum": 0 + }, + "warnings": { + "type": "integer", + "minimum": 0 + }, + "passes": { + "type": "integer", + "minimum": 0 + }, + "infos": { + "type": "integer", + "minimum": 0 + }, + "deviceWithErrors": { + "type": "integer", + "minimum": 0 + }, + "deviceWithWarnings": { + "type": "integer", + "minimum": 0 + }, + "deviceWithInfos": { + "type": "integer", + "minimum": 0 + }, + "fullyCompliantDevices": { + "type": "integer", + "minimum": 0 + }, + "numDevices": { + "type": "integer", + "minimum": 0 + } + } + }, + "configuration_manager_goldenConfigData_complianceReport": { + "title": "complianceReport", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "batchId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "treeId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "version": { + "title": "goldenConfigTreeVersionName", + "type": "string", + "examples": ["initial", "v2", "v3", "draft-v4"] + }, + "nodePath": { + "title": "goldenConfigNodePath", + "type": "string", + "examples": ["base", "base/US East", "base/US East/Atlanta"] + }, + "deviceType": { + "type": "string", + "examples": ["cisco-ios", "cisco-ios-xr", "junos"] + }, + "specId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "inheritedSpecIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + }, + "deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "variables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["variable name"] + }, + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["variable value"] + } + } + } + }, + "timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "totals": { + "type": "object", + "properties": { + "errors": { + "type": "integer", + "minimum": 0 + }, + "warnings": { + "type": "integer", + "minimum": 0 + }, + "infos": { + "type": "integer", + "minimum": 0 + }, + "passes": { + "type": "integer", + "minimum": 0 + } + } + }, + "issues": { + "type": "array", + "items": { + "title": "complianceIssue", + "type": "object", + "properties": { + "severity": { + "enum": ["error", "warning", "info"] + }, + "type": { + "enum": ["required", "disallowed"] + }, + "message": { + "type": "string", + "examples": ["Required config not found"] + }, + "specLineId": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "path": { + "type": "array", + "items": { + "type": "string", + "examples": ["interface GigE1"] + } + }, + "spec": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": ["required", "disallowed", "ignored", "optional"] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": {} + } + } + }, + "configWords": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "literal" + }, + "value": { + "type": "string", + "examples": ["word"] + } + } + } + }, + "candidates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "literal" + }, + "value": { + "type": "string", + "examples": ["word"] + } + } + } + } + } + } + }, + "score": { + "type": "number" + } + } + }, + "configuration_manager_goldenConfigData_complianceReportBrief": { + "title": "complianceReportBrief", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "batchId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "treeId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "version": { + "type": "string", + "examples": ["initial", "v2", "v3", "draft v4"] + }, + "nodePath": { + "title": "goldenConfigNodePath", + "type": "string", + "examples": ["base", "base/US East", "base/US East/Atlanta"] + }, + "deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "totals": { + "type": "object", + "properties": { + "errors": { + "type": "integer", + "minimum": 0 + }, + "warnings": { + "type": "integer", + "minimum": 0 + }, + "infos": { + "type": "integer", + "minimum": 0 + }, + "passes": { + "type": "integer", + "minimum": 0 + } + } + } + } + }, + "configuration_manager_goldenConfigData_complianceReportBriefGraded": { + "title": "complianceReportBriefGraded", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "error": { + "type": "integer", + "minimum": 0 + }, + "warning": { + "type": "integer", + "minimum": 0 + }, + "info": { + "type": "integer", + "minimum": 0 + }, + "pass": { + "type": "integer", + "minimum": 0 + }, + "score": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "grade": { + "type": "string", + "examples": ["pass", "review", "fail"] + } + } + }, + "configuration_manager_goldenConfigData_complianceReportGraded": { + "title": "complianceReportGraded", + "allOf": [ + { + "title": "complianceReport", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "batchId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "treeId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "version": { + "title": "goldenConfigTreeVersionName", + "type": "string", + "examples": ["initial", "v2", "v3", "draft-v4"] + }, + "nodePath": { + "title": "goldenConfigNodePath", + "type": "string", + "examples": ["base", "base/US East", "base/US East/Atlanta"] + }, + "deviceType": { + "type": "string", + "examples": ["cisco-ios", "cisco-ios-xr", "junos"] + }, + "specId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "inheritedSpecIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + }, + "deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "variables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["variable name"] + }, + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["variable value"] + } + } + } + }, + "timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "totals": { + "type": "object", + "properties": { + "errors": { + "type": "integer", + "minimum": 0 + }, + "warnings": { + "type": "integer", + "minimum": 0 + }, + "infos": { + "type": "integer", + "minimum": 0 + }, + "passes": { + "type": "integer", + "minimum": 0 + } + } + }, + "issues": { + "type": "array", + "items": { + "title": "complianceIssue", + "type": "object", + "properties": { + "severity": { + "enum": ["error", "warning", "info"] + }, + "type": { + "enum": ["required", "disallowed"] + }, + "message": { + "type": "string", + "examples": ["Required config not found"] + }, + "specLineId": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "path": { + "type": "array", + "items": { + "type": "string", + "examples": ["interface GigE1"] + } + }, + "spec": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": [ + "required", + "disallowed", + "ignored", + "optional" + ] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": {} + } + } + }, + "configWords": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "literal" + }, + "value": { + "type": "string", + "examples": ["word"] + } + } + } + }, + "candidates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "literal" + }, + "value": { + "type": "string", + "examples": ["word"] + } + } + } + } + } + } + }, + "score": { + "type": "number" + } + } + }, + { + "type": "object", + "properties": { + "score": { + "type": "number" + }, + "grade": { + "type": "string", + "examples": ["pass", "fail", "review"] + } + } + } + ] + }, + "automation-studio_automation": { + "title": "workflow document", + "description": "Third generation workflow document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "namespace": { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + }, + "name": { + "type": "string", + "examples": [ + "Port Turn Up IOS", + "Push Config to Device", + "Command Template Runner" + ] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "string", + "examples": ["Port Turn Up IOS", "Push Config to Device"] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "integer", + "title": "Pre automation time of automation", + "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", + "examples": [5000, 250000] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "workflow_end": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "sla": { + "type": "integer", + "title": "Task SLA", + "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", + "examples": ["3600000"] + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": {}, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": {}, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "canvasVersion": { + "type": "number", + "const": 3 + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + } + }, + "additionalProperties": false, + "required": [ + "name", + "type", + "tasks", + "transitions", + "groups", + "canvasVersion" + ] + }, + "automation-studio_automationUpdate": { + "title": "workflow document", + "description": "Third generation workflow document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "namespace": { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + }, + "name": { + "type": "string", + "examples": [ + "Port Turn Up IOS", + "Push Config to Device", + "Command Template Runner" + ] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "string", + "examples": ["Port Turn Up IOS", "Push Config to Device"] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "integer", + "title": "Pre automation time of automation", + "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", + "examples": [5000, 250000] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "workflow_end": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "sla": { + "type": "integer", + "title": "Task SLA", + "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", + "examples": ["3600000"] + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": {}, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": {}, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "canvasVersion": { + "type": "number", + "const": 3 + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + } + }, + "additionalProperties": false, + "required": [ + "name", + "type", + "tasks", + "transitions", + "groups", + "canvasVersion" + ] + }, + "automation-studio_componentGroup": { + "title": "Component Group Document", + "description": "An entity representing a component group.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the component group" + }, + "name": { + "type": "string", + "examples": ["Infoblox Workflows"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["Infoblox Workflows"] + }, + "gbacRead": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "CAcFAfEa9aCe7ba08d482B3F", + "F880C8dEBAf70BfB85ec7eCc", + "5AC59E1De2Ce2203cFeb3E22" + ] + } + }, + "gbacWrite": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "CAcFAfEa9aCe7ba08d482B3F", + "F880C8dEBAf70BfB85ec7eCc", + "5AC59E1De2Ce2203cFeb3E22" + ] + } + }, + "members": { + "type": "array", + "items": { + "type": "object", + "oneOf": [ + { + "properties": { + "path": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + } + }, + "type": { + "enum": ["folder"] + } + } + }, + { + "properties": { + "path": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + }, + "type": { + "enum": ["component"] + }, + "sourceCollection": { + "type": "string", + "examples": ["workflows", "json-forms", "transformations"] + }, + "ref": { + "type": "string", + "examples": ["7192B8CcD680858dA81EADCa"] + } + } + } + ] + } + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "meta": { + "type": "object" + } + }, + "required": ["name", "gbacRead", "members"], + "additionalProperties": false + }, + "automation-studio_componentGroupImport": { + "title": "Component Group Import Data", + "description": "Data to import as a new component group document.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the component group" + }, + "name": { + "type": "string", + "examples": ["Assign Next IP - Infoblox", "Get Next IP - Infoblox"], + "minLength": 1 + }, + "gbacRead": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "CAcFAfEa9aCe7ba08d482B3F", + "F880C8dEBAf70BfB85ec7eCc", + "5AC59E1De2Ce2203cFeb3E22" + ] + } + }, + "members": { + "type": "array", + "items": { + "type": "object", + "oneOf": [ + { + "properties": { + "path": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + } + }, + "type": { + "enum": ["folder"] + } + } + }, + { + "properties": { + "path": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + }, + "type": { + "enum": ["component"] + }, + "sourceCollection": { + "type": "string", + "examples": ["workflows", "json-forms", "transformations"] + }, + "ref": { + "type": "string", + "examples": ["7192B8CcD680858dA81EADCa"] + } + } + } + ] + } + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "meta": { + "type": "object" + } + }, + "required": ["name", "gbacRead", "members"], + "additionalProperties": false + }, + "automation-studio_componentGroupUpdate": { + "title": "Component Group Update", + "description": "An entity representing an update to an existing template document.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the component group" + }, + "name": { + "type": "string", + "examples": ["Assign Next IP - Infoblox", "Get Next IP - Infoblox"], + "minLength": 1 + }, + "gbacRead": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "CAcFAfEa9aCe7ba08d482B3F", + "F880C8dEBAf70BfB85ec7eCc", + "5AC59E1De2Ce2203cFeb3E22" + ] + } + }, + "members": { + "type": "array", + "items": { + "type": "object", + "oneOf": [ + { + "properties": { + "path": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + } + }, + "type": { + "enum": ["folder"] + } + } + }, + { + "properties": { + "path": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + }, + "type": { + "enum": ["component"] + }, + "sourceCollection": { + "type": "string", + "examples": ["workflows", "json-forms", "transformations"] + }, + "ref": { + "type": "string", + "examples": ["7192B8CcD680858dA81EADCa"] + } + } + } + ] + } + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "meta": { + "type": "object" + } + }, + "required": ["name", "gbacRead", "members"], + "additionalProperties": false + }, + "automation-studio_project-thumbnails-update-data": { + "title": "Project Thumbnail Update Values", + "description": "Project Thumbnail Update Values", + "type": "object", + "required": ["imageData"], + "properties": { + "imageData": { + "description": "Binary image data encoded as a base64 string", + "type": "string" + }, + "backgroundColor": { + "description": "Thumbnail background color", + "type": "string", + "default": "#FFFFFF" + } + } + }, + "automation-studio_projects-common_components": { + "title": "Project components", + "description": "A list of member components in the project", + "type": "array", + "items": { + "title": "Project component", + "description": "An IAP component which resides within a project", + "type": "object", + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string", + "examples": [ + "1Ac4B2268489019745B5baa4", + "2D772A00dd2Ccedf3bd313bd", + "866a9B98DdD58Ff0e14ebB16" + ] + }, + "folder": { + "title": "Project component folder", + "description": "", + "type": "string", + "pattern": "^/" + } + } + } + }, + "automation-studio_projects-create-data": { + "title": "Project Create Data", + "description": "POST body properties required to create a project", + "type": "object", + "additionalProperties": true, + "required": ["name"], + "properties": { + "name": { + "description": "Project name", + "type": "string", + "examples": [ + "Firewall Service Provisioning", + "Arista EOS Utilities", + "Github" + ] + }, + "description": { + "title": "Project description", + "description": "A free-form block of text for describing project intent and function", + "type": "string", + "examples": [ + "This project is used at Acme Corp as the foundation of some major parts of our business process.", + "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" + ] + }, + "components": { + "title": "Project components", + "description": "A list of member components in the project", + "type": "array", + "items": { + "title": "Project component", + "description": "An IAP component which resides within a project", + "type": "object", + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string", + "examples": [ + "1Ac4B2268489019745B5baa4", + "2D772A00dd2Ccedf3bd313bd", + "866a9B98DdD58Ff0e14ebB16" + ] + }, + "folder": { + "title": "Project component folder", + "description": "", + "type": "string", + "pattern": "^/" + } + } + } + } + } + }, + "automation-studio_projects-export-v1": { + "title": "Project Export Document", + "description": "An exported project document", + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "iid", + "name", + "description", + "thumbnail", + "backgroundColor", + "components", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "name": { + "description": "Project name", + "type": "string", + "examples": [ + "Firewall Service Provisioning", + "Arista EOS Utilities", + "Github" + ] + }, + "description": { + "title": "Project description", + "description": "A free-form block of text for describing project intent and function", + "type": "string", + "examples": [ + "This project is used at Acme Corp as the foundation of some major parts of our business process.", + "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" + ] + }, + "thumbnail": { + "description": "Base64 string encoding binary image data for project thumbnail", + "type": "string" + }, + "backgroundColor": { + "description": "Thumbnail background color", + "type": "string", + "default": "#FFFFFF" + }, + "components": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": ["iid", "type", "reference", "folder", "document"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string", + "examples": [ + "1Ac4B2268489019745B5baa4", + "2D772A00dd2Ccedf3bd313bd", + "866a9B98DdD58Ff0e14ebB16" + ] + }, + "folder": { + "title": "Project component folder", + "description": "", + "type": "string", + "pattern": "^/" + }, + "document": { + "title": "Component export", + "description": "Full component document", + "type": "object" + } + } + } + }, + "referencedComponentHashes": { + "oneOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "items": { + "type": "object", + "additionalProperties": false, + "required": ["type", "reference", "hash", "name"], + "properties": { + "type": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The last known name of the exported document" + }, + "hash": { + "type": "string" + }, + "query": { + "type": "object" + } + } + } + }, + "referencedComponents": { + "oneOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "items": { + "type": "object", + "additionalProperties": false, + "required": ["type", "reference", "document"], + "properties": { + "type": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "document": { + "title": "Referenced component export", + "description": "Full referenced component document", + "type": "object" + } + } + } + }, + "folders": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "required": ["name", "nodeType", "children"], + "properties": { + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "name": { + "description": "Folder name", + "type": "string", + "examples": ["folder-1", "folder-2"] + }, + "children": { + "type": "array", + "items": { + "oneOf": [ + {}, + { + "type": "object", + "required": ["iid", "nodeType"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string" + } + } + } + ] + } + } + } + }, + { + "type": "object", + "required": ["iid", "nodeType"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string" + } + } + } + ] + } + }, + "created": { + "title": "ISO Date String", + "description": "ISO Date String", + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "createdBy": {}, + "lastUpdated": { + "title": "ISO Date String", + "description": "ISO Date String", + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "lastUpdatedBy": {}, + "versionHistory": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": [ + "versionNumber", + "commitMessage", + "author", + "branchName" + ], + "properties": { + "versionNumber": { + "type": "integer", + "examples": [1] + }, + "commitMessage": { + "type": "string" + }, + "author": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + } + } + } + } + } + }, + "automation-studio_projects-http-id": { + "title": "Projects HTTP ID", + "description": "Project identifier as understood by the HTTP API", + "oneOf": [ + { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + } + ] + }, + "automation-studio_projects-http": { + "title": "Project HTTP Data", + "description": "Project data as it is sent back from get and search endpoints", + "type": "object", + "additionalProperties": false, + "required": [], + "properties": { + "_id": { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "name": { + "description": "Project name", + "type": "string", + "examples": [ + "Firewall Service Provisioning", + "Arista EOS Utilities", + "Github" + ] + }, + "description": { + "title": "Project description", + "description": "A free-form block of text for describing project intent and function", + "type": "string", + "examples": [ + "This project is used at Acme Corp as the foundation of some major parts of our business process.", + "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" + ] + }, + "members": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": ["type", "reference", "role"], + "properties": { + "type": { + "type": "string", + "enum": ["account", "group"] + }, + "reference": { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "role": { + "type": "string", + "enum": ["owner", "editor", "operator", "viewer"] + }, + "missing": { + "type": "boolean" + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + } + } + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + }, + "componentIidIndex": { + "title": "Component IID Index", + "description": "Read-only property providing incrementing integer ID values for child components within a project", + "type": "integer", + "minimum": 0 + }, + "components": { + "title": "Project components", + "description": "A list of member components in the project", + "type": "array", + "items": { + "title": "Project component", + "description": "An IAP component which resides within a project", + "type": "object", + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string", + "examples": [ + "1Ac4B2268489019745B5baa4", + "2D772A00dd2Ccedf3bd313bd", + "866a9B98DdD58Ff0e14ebB16" + ] + }, + "folder": { + "title": "Project component folder", + "description": "", + "type": "string", + "pattern": "^/" + } + } + } + }, + "folders": { + "title": "Project folders", + "description": "A list of folders and their members", + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "required": ["name", "nodeType", "children"], + "properties": { + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "name": { + "description": "Folder name", + "type": "string", + "examples": ["folder-1", "folder-2"] + }, + "children": { + "type": "array", + "items": { + "oneOf": [ + {}, + { + "type": "object", + "required": ["iid", "nodeType"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string" + } + } + } + ] + } + } + } + }, + { + "type": "object", + "required": ["iid", "nodeType"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string" + } + } + } + ] + } + }, + "created": { + "title": "ISO Date String", + "description": "ISO Date String", + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "createdBy": {}, + "lastUpdated": { + "title": "ISO Date String", + "description": "ISO Date String", + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "lastUpdatedBy": {}, + "versionHistory": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": [ + "versionNumber", + "commitMessage", + "author", + "branchName" + ], + "properties": { + "versionNumber": { + "type": "integer", + "examples": [1] + }, + "commitMessage": { + "type": "string" + }, + "author": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + } + } + } + }, + "gitConfiguration": { + "type": "object", + "additionalProperties": false, + "required": [ + "connectionType", + "repositoryPath", + "branchName", + "projectPath" + ], + "properties": { + "connectionType": { + "type": "string", + "enum": ["GitHub", "GitLab"] + }, + "repositoryPath": { + "type": "string", + "examples": ["Itential Open Source"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + }, + "projectPath": { + "type": "string", + "examples": ["Projects"] + } + } + } + } + }, + "automation-studio_projects-search-parameters": { + "title": "Project Search Parameters", + "description": "Parameters used to filter and paginate Project documents in the Project search API", + "type": "object", + "additionalProperties": true, + "properties": { + "equals": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "iid": { + "type": "number" + }, + "name": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "lastUpdatedBy": { + "type": "string" + } + } + }, + "in": { + "type": "object", + "properties": { + "_id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "iid": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "name": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "createdBy": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + } + }, + "starts-with": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "contains": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "name,description": { + "type": "string" + }, + "description,name": { + "type": "string" + } + } + }, + "sort": { + "type": "string", + "enum": [ + "_id", + "iid", + "name", + "created", + "lastUpdated", + "createdBy", + "lastUpdatedBy" + ] + }, + "order": { + "type": "string", + "enum": ["asc", "desc"] + }, + "skip": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "limit": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + } + } + }, + "automation-studio_projects-update-data": { + "title": "Project Update Data", + "description": "PATCH body properties used to update a project", + "type": "object", + "additionalProperties": true, + "properties": { + "name": { + "description": "Project name", + "type": "string", + "examples": [ + "Firewall Service Provisioning", + "Arista EOS Utilities", + "Github" + ] + }, + "description": { + "title": "Project description", + "description": "A free-form block of text for describing project intent and function", + "type": "string", + "examples": [ + "This project is used at Acme Corp as the foundation of some major parts of our business process.", + "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" + ] + }, + "thumbnailBackgroundColor": { + "description": "Thumbnail background color", + "type": "string", + "default": "#FFFFFF" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "required": ["type", "reference", "role"], + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": ["account", "group"] + }, + "reference": { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "role": { + "type": "string", + "enum": ["owner", "editor", "operator", "viewer"] + } + } + } + }, + "version": { + "type": "object", + "additionalProperties": false, + "required": [ + "versionNumber", + "commitMessage", + "author", + "branchName" + ], + "properties": { + "versionNumber": { + "type": "integer", + "examples": [1] + }, + "commitMessage": { + "type": "string" + }, + "author": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + } + } + }, + "gitConfiguration": { + "type": "object", + "additionalProperties": false, + "required": [ + "connectionType", + "repositoryPath", + "branchName", + "projectPath" + ], + "properties": { + "connectionType": { + "type": "string", + "enum": ["GitHub", "GitLab"] + }, + "repositoryPath": { + "type": "string", + "examples": ["Itential Open Source"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + }, + "projectPath": { + "type": "string", + "examples": ["Projects"] + } + } + } + } + }, + "automation-studio_resource-ref-http": { + "title": "ResourceRef HTTP Data", + "description": "The resourceRef objects that are returned from getReferences", + "type": "object", + "additionalProperties": false, + "required": [ + "resourceType", + "resourcePointer", + "resourceId", + "parents" + ], + "properties": { + "resourceType": { + "type": "string" + }, + "resourcePointer": { + "type": "string" + }, + "resourceId": { + "type": "string" + }, + "root": { + "type": "boolean" + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": [ + "resourceType", + "resourcePointer", + "resourceId", + "parentPointer" + ], + "properties": { + "resourceType": { + "type": "string" + }, + "resourcePointer": { + "type": "string" + }, + "resourceId": { + "type": "string" + }, + "root": { + "type": "boolean" + }, + "parentPointer": { + "type": "string" + } + } + } + }, + "resource": { + "type": "object", + "description": "When using 'includeResources', this property will contain the full resource object" + } + } + }, + "automation-studio_taskDetails": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "title": "The Root Schema", + "required": ["location", "name", "app", "variables"], + "properties": { + "location": { + "type": "string", + "enum": ["Application", "Adapter", "Broker"] + }, + "name": { + "type": "string", + "examples": ["query"] + }, + "app": { + "type": "string", + "examples": ["WorkFlowEngine"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "string", + "number", + "array", + "object", + "enum", + "boolean", + "*" + ] + }, + "description": { + "type": "string", + "examples": ["Example description"] + }, + "schema": { + "type": "object" + } + } + } + }, + "outgoing": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "string", + "number", + "array", + "object", + "enum", + "boolean", + "*" + ] + }, + "description": { + "type": "string", + "examples": ["Example description"] + }, + "schema": { + "type": "object" + } + } + } + } + } + } + } + }, + "automation-studio_template": { + "title": "Template Document", + "description": "An entity representing a data template.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the automation" + }, + "namespace": { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + }, + "name": { + "type": "string", + "examples": ["arista_eos_show_clock"], + "minLength": 1, + "pattern": "^(?!\\s)[\\w\\s]+(? Record\n" + ], + "minLength": 1 + }, + "data": { + "type": "string", + "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], + "minLength": 1 + }, + "type": { + "type": "string", + "examples": ["textfsm", "jinja2"], + "enum": ["textfsm", "jinja2"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the automation" + }, + "created": { + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "lastUpdatedBy": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the automation" + }, + "lastUpdated": { + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "description": "A user-defined object to help group documents.", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the automation" + }, + "name": { + "type": "string", + "description": "user-given, unique string to ID tag" + } + } + } + } + }, + "required": [ + "name", + "group", + "command", + "description", + "template", + "data", + "type" + ], + "additionalProperties": false + }, + "automation-studio_templateImport": { + "title": "Template Import Data", + "description": "Data to import as a new template document.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "Unique identifier of the automation" + }, + "name": { + "type": "string", + "examples": ["arista_eos_show_clock"], + "minLength": 1 + }, + "projectId": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$" + } + ] + }, + "group": { + "type": "string", + "examples": ["Arista"], + "minLength": 1 + }, + "device": { + "type": "string", + "examples": ["Arista EOS"], + "minLength": 1 + }, + "command": { + "type": "string", + "examples": ["show clock"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["Arista Show Clock Info"], + "minLength": 1 + }, + "template": { + "type": "string", + "examples": [ + "Value TIME (d+:d+:d+)\nValue TIMEZONE (S+)\nValue DAYWEEK (w+)\nValue MONTH (w+)\nValue DAY (d+)\nValue YEAR (d+)\n\nStart\n ^${DAYWEEK}s+${MONTH}s+${DAY}s+${TIME}s+${YEAR}\n ^[t|T]imezone(:|sis)s+${TIMEZONE} -> Record\n" + ], + "minLength": 1 + }, + "data": { + "type": "string", + "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], + "minLength": 1 + }, + "text": { + "type": "string", + "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], + "minLength": 1 + }, + "type": { + "type": "string", + "examples": ["textfsm", "jinja2"], + "enum": ["textfsm", "jinja2"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "Unique identifier of the automation" + }, + "created": { + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "lastModifiedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "Unique identifier of the automation" + }, + "lastUpdated": { + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "description": "A user-defined object to help group documents.", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "Unique identifier of the automation" + }, + "name": { + "type": "string", + "description": "user-given, unique string to ID tag" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "_id", + "name", + "group", + "command", + "description", + "template", + "data", + "type" + ] + }, + { + "required": [ + "_id", + "name", + "device", + "command", + "template", + "text", + "type" + ] + } + ], + "additionalProperties": false + }, + "automation-studio_templateUpdate": { + "title": "Template Update", + "description": "An entity representing an update to an existing template document.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["arista_eos_show_clock"], + "minLength": 1 + }, + "group": { + "type": "string", + "examples": ["Arista"], + "minLength": 1 + }, + "projectId": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$" + } + ] + }, + "command": { + "type": "string", + "examples": ["show clock"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["Arista Show Clock Info"], + "minLength": 1 + }, + "template": { + "type": "string", + "examples": [ + "Value TIME (d+:d+:d+)\nValue TIMEZONE (S+)\nValue DAYWEEK (w+)\nValue MONTH (w+)\nValue DAY (d+)\nValue YEAR (d+)\n\nStart\n ^${DAYWEEK}s+${MONTH}s+${DAY}s+${TIME}s+${YEAR}\n ^[t|T]imezone(:|sis)s+${TIMEZONE} -> Record\n" + ], + "minLength": 1 + }, + "data": { + "type": "string", + "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], + "minLength": 1 + }, + "type": { + "type": "string", + "examples": ["textfsm", "jinja2"], + "enum": ["textfsm", "jinja2"] + } + }, + "required": [ + "name", + "group", + "command", + "description", + "template", + "data", + "type" + ], + "additionalProperties": false + }, + "automation-studio_workflowDocument": { + "title": "workflow document", + "description": "Third generation workflow document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "namespace": { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + }, + "name": { + "type": "string", + "examples": [ + "Port Turn Up IOS", + "Push Config to Device", + "Command Template Runner" + ] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "string", + "examples": ["Port Turn Up IOS", "Push Config to Device"] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "integer", + "title": "Pre automation time of automation", + "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", + "examples": [5000, 250000] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "workflow_end": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "sla": { + "type": "integer", + "title": "Task SLA", + "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", + "examples": ["3600000"] + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": {}, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": {}, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "canvasVersion": { + "type": "number", + "const": 3 + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + } + }, + "additionalProperties": false, + "required": [ + "name", + "type", + "tasks", + "transitions", + "groups", + "canvasVersion" + ] + }, + "automation-studio_workflowDocumentAll": { + "title": "workflow document", + "description": "Accepts all generation workflow documents", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + "name": { + "type": "string", + "examples": [ + "Port Turn Up IOS", + "Push Config to Device", + "Command Template Runner" + ] + }, + "type": { + "type": "string", + "default": "automation" + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + } + ] + }, + "description": { + "oneOf": [ + { + "type": "string", + "examples": ["Port Turn Up IOS", "Push Config to Device"] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "number", + "examples": [5000, 250000] + }, + "sla": { + "type": "number", + "examples": [10] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + } + }, + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + } + ] + }, + "workflow_end": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + } + }, + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string" + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "additionalProperties": false + }, + "errorHandler": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + ] + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": { + "oneOf": [ + { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["username", "provenance"] + }, + { + "type": "null" + } + ] + }, + "createdVersion": { + "type": "string", + "examples": ["5.40.5-2021.1.72.0"] + }, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": { + "oneOf": [ + { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["username", "provenance"] + }, + { + "type": "null" + } + ] + }, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": ["_id", "name", "description"] + } + }, + "canvasVersion": { + "type": "number", + "enum": [1, 1.5, 2, 3] + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + }, + "inputSchema": { + "type": "object" + }, + "outputSchema": { + "type": "object" + }, + "outputData": { + "type": "object" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "migrationVersion": { + "type": "integer", + "minimum": 0 + } + }, + "additionalProperties": true, + "required": ["name", "type", "tasks", "transitions", "groups"] + }, + "tags_tagDocument_tagName": { + "type": "string", + "examples": ["My Tag"] + }, + "tags_tagDocument_tagId": { + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + }, + "tags_tagDocument_tagDescription": { + "type": "string", + "examples": ["Descriptions can be empty"] + }, + "tags_tagDocument_contentRefId": { + "type": "string", + "examples": ["The id of the content to be referenced"] + }, + "tags_tagDocument_contentRefType": { + "type": "string", + "examples": ["The id of the content to be referenced"] + }, + "tags_tagDocument_tagObject": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + }, + "description": { + "type": "string", + "examples": ["Descriptions can be empty"] + }, + "name": { + "type": "string", + "examples": ["My Tag"] + } + } + }, + "tags_tagDocument_referenceObject": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["new created reference id"] + }, + "tag_id": { + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + }, + "ref_id": { + "type": "string", + "examples": ["The id of the content to be referenced"] + }, + "type": { + "type": "string", + "examples": ["The id of the content to be referenced"] + } + } + }, + "workflow_engine_jobMetricsDocument": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "title": "Job metrics schema", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "workflow": { + "type": "object", + "title": "Automation the job was started on.", + "properties": { + "name": { + "type": "string", + "title": "Name of the automation the job was started on", + "examples": ["exampleAutomationName"] + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "Automation objectId the job was started on", + "examples": [ + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + } + } + }, + "preAutomationTime": { + "type": "integer", + "title": "Pre automation time of automation", + "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", + "examples": [5000, 250000] + }, + "metrics": { + "type": "array", + "title": "Weekly aggregate metrics", + "description": "Aggregate job metrics collected on a weekly basis", + "items": { + "type": "object", + "properties": { + "jobsComplete": { + "type": "integer", + "title": "Jobs complete for automation", + "description": "Total number of jobs complete for automation for the week starting at startDate.", + "minimum": 0, + "examples": [10, 40] + }, + "totalRunTime": { + "type": "integer", + "title": "Total run time for automation", + "description": "Total run time (milliseconds) of jobs complete for automation for the week starting at startDate.", + "minimum": 0, + "examples": [200, 700] + }, + "totalManualTime": { + "type": "integer", + "title": "Total manual time for automation", + "description": "Total time (milliseconds) spent working manual a task for automation for the week starting at startDate.", + "minimum": 0, + "examples": [200, 700] + }, + "slaTargetsMissed": { + "type": "integer", + "title": "Sla targets missed for automation.", + "description": "Total number of sla targets that were missed for an automation for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + }, + "startDate": { + "type": "string", + "title": "Start DateTime of metric collection", + "description": "Metrics are collected on a weekly interval, starting at startDate", + "examples": [ + "2018-08-02T15:56:12.912Z", + "2019-09-06T12:52:24.933Z" + ] + } + }, + "required": [ + "jobsComplete", + "totalRunTime", + "totalManualTime", + "slaTargetsMissed", + "startDate" + ] + } + } + }, + "required": ["_id", "workflow", "metrics"] + }, + "workflow_engine_taskMetricsDocument": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "title": "Default metrics schema", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "app": { + "type": "string", + "title": "The associated app for this task", + "examples": ["WorkflowBuilder"] + }, + "name": { + "type": "string", + "title": "The name of the task", + "examples": ["getTime", "testTask"] + }, + "taskType": { + "type": "string", + "title": "The type of the task", + "enum": ["automatic", "manual", "operation"] + }, + "global": { + "type": "boolean", + "title": "Global task", + "description": "Global designating if metric is global across automations or per-automation.", + "examples": [true, false] + }, + "taskId": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$|^workflow_start$|^workflow_end$", + "title": "Workflow task id", + "description": "Four character hexadecimal task identifier", + "examples": ["12ab", "cd34"] + }, + "workflow": { + "type": "object", + "title": "Automation the job was started on.", + "properties": { + "name": { + "type": "string", + "title": "Name of the automation the job was started on", + "examples": ["exampleAutomationName"] + } + } + }, + "metrics": { + "type": "array", + "title": "Weekly aggregate metrics", + "description": "Aggregate job metrics collected on a weekly basis", + "items": { + "type": "object", + "properties": { + "startDate": { + "type": "string", + "title": "Start DateTime of metric collection", + "description": "Metrics are collected on a weekly interval, starting at startDate.", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "totalSuccesses": { + "type": "integer", + "title": "Total successes for a task", + "description": "Total number of tasks that ended in status success for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + }, + "totalSuccessRunTime": { + "type": "integer", + "title": "Total successes run time for a task", + "description": "Total run time (milliseconds) for tasks that ended in status success for the week starting at startDate.", + "minimum": 0, + "examples": [550, 200] + }, + "totalErrors": { + "type": "integer", + "title": "Total errors for a task", + "description": "Total number of tasks that ended in status error for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + }, + "totalErrorRunTime": { + "type": "integer", + "title": "Total error run time for a task", + "description": "Total run time (milliseconds) for tasks that ended in status error for the week starting at startDate.", + "minimum": 0, + "examples": [550, 200] + }, + "totalFailures": { + "type": "integer", + "title": "Total failures for a task", + "description": "Total number of tasks that ended in status failure for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + }, + "totalFailureRunTime": { + "type": "integer", + "title": "Total failure run time for a task", + "description": "Total run time (milliseconds) for tasks that ended in status failure for the week starting at startDate.", + "minimum": 0, + "examples": [550, 200] + }, + "slaTargetsMissed": { + "type": "integer", + "title": "Sla targets missed for a manual task", + "description": "Total number of sla targets that were missed for a manual task for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + } + }, + "required": [ + "startDate", + "totalSuccesses", + "totalSuccessRunTime", + "totalErrorRunTime", + "totalErrors", + "totalFailureRunTime", + "totalFailures" + ] + } + } + }, + "required": [ + "_id", + "app", + "name", + "type", + "taskType", + "global", + "metrics" + ] + }, + "workflow_engine_wfEngineCommon_skip": { + "type": "integer", + "description": "The number of documents skipped before returning data. When 0, no data is skipped.", + "minimum": 0, + "examples": [0] + }, + "workflow_engine_wfEngineCommon_limit": { + "type": "integer", + "title": "The returned document limit", + "description": "Specifies a limit to the maximum number of data results returned.", + "minimum": 0, + "maximum": 100, + "examples": [50] + }, + "workflow_engine_wfEngineCommon_sort": { + "type": "string", + "description": "Field to sort by. Default is workflow.name.", + "default": "workflow.name" + }, + "workflow_engine_wfEngineCommon_order": { + "type": "integer", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "default": 1, + "enum": [-1, 1] + }, + "workflow_engine_wfEngineCommon_total": { + "type": "integer", + "description": "The total number of documents returned from a search.", + "minimum": 0, + "examples": [100] + }, + "workflow_engine_wfEngineCommon_evaluationItem": { + "type": "object", + "title": "Evaluation Object", + "description": "Contains all the items/properties needed for a comparison operation/evaluation", + "required": ["operand_1", "operator", "operand_2"], + "properties": { + "query": { + "type": "string", + "title": "Query for first operand", + "description": "Query the operand_1 (optional)", + "examples": [ + "somePropertyNameInOperand_1IfItIsAnObject.nestedProperty" + ] + }, + "rightQuery": { + "type": "string", + "title": "Query for second operand", + "description": "Query the operand_2 (optional)", + "examples": [ + "somePropertyNameInOperand_2IfItIsAnObject.nestedProperty" + ] + }, + "operand_1": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "boolean" + }, + { + "type": "number" + } + ], + "title": "A comparison value", + "description": "Used in evaluations as either the object to compare, or the object to compare to" + }, + "operator": { + "type": "string", + "enum": ["contains", "!contains", "<", "<=", ">", ">=", "==", "!="], + "title": "The Operator ", + "description": "The operation (contains, !contains, <,<=, etc)", + "examples": ["contains"] + }, + "operand_2": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "boolean" + }, + { + "type": "number" + } + ], + "title": "A comparison value", + "description": "Used in evaluations as either the object to compare, or the object to compare to" + } + } + }, + "workflow_engine_wfEngineCommon_mongoObjectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "json-forms_formBindingSchema_bindingSchema": { + "type": "object" + }, + "json-forms_formDocument_form": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2019-04-16T00:43:22.038Z"] + }, + "createdBy": { + "type": "string", + "examples": ["5cb08d4f16640f00182c3890"] + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "examples": ["2019-04-16T00:43:22.038Z"] + }, + "lastUpdatedBy": { + "type": "string", + "examples": ["5cb08d4f16640f00182c3890"] + }, + "name": { + "type": "string", + "examples": ["Device Form"] + }, + "tags": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + { + "type": "object" + } + ] + } + }, + "description": { + "anyOf": [ + { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + { + "type": "null" + } + ] + }, + "struct": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "projectId": { + "type": "string" + }, + "type": { + "type": "string" + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "array" + } + ] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "This section describes the connection information for a device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": [ + "Enter connection retry attempt count" + ] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + }, + "collapsed": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "schemaOption": { + "type": "boolean" + }, + "combinationType": { + "type": "string" + }, + "widget": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "items"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "required": ["type", "items"], + "additionalProperties": false, + "definitions": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "container": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "array" + } + ] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "This section describes the connection information for a device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "array" + } + ] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "This section describes the connection information for a device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": [ + "Enter connection retry attempt count" + ] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + }, + "collapsed": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "schemaOption": { + "type": "boolean" + }, + "combinationType": { + "type": "string" + }, + "widget": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "items"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": [ + "Enter connection retry attempt count" + ] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + }, + "collapsed": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "schemaOption": { + "type": "boolean" + }, + "combinationType": { + "type": "string" + }, + "widget": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "items"], + "additionalProperties": false + }, + "checkboxField": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": ["Is a timeout allowed to pass this step?"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + }, + "numberField": { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + "textField": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + "textareaField": { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + "dropdownField": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + "fileUploadField": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + } + } + }, + "schema": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "readOnly": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file."] + }, + "format": { + "type": "string", + "const": "data-url" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": { + "type": "boolean" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + } + } + }, + "anyOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "oneOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "allOf": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["type", "title"] + }, + "uiSchema": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "ui:widget": { + "type": "string", + "const": "updown" + } + }, + "required": ["ui:widget"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's config"] + }, + "ui:widget": { + "type": "string", + "const": "textarea" + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Select device"] + } + } + } + ] + } + } + }, + "validationSchema": { + "type": "object" + }, + "bindingSchema": { + "type": "object" + }, + "version": { + "type": "string", + "examples": ["2020.1"] + }, + "id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + "required": [ + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy", + "name", + "description", + "struct", + "schema", + "uiSchema", + "bindingSchema", + "validationSchema", + "version" + ], + "additionalProperties": false + }, + "json-forms_formDocument_formId": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "json-forms_formDocument_formData": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + }, + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + } + }, + "json-forms_formDocument_validationResponse": { + "type": "object", + "properties": { + "status": { + "type": "integer", + "enum": [200, 404] + }, + "validation": { + "type": "object", + "properties": { + "valid": { + "type": "boolean" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "message": { + "type": "string", + "examples": ["Form data is valid."] + } + } + }, + "json-forms_formDocument_importResultReport": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2019-04-16T00:43:22.038Z"] + }, + "createdBy": { + "type": "string", + "examples": ["5cb08d4f16640f00182c3890"] + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "examples": ["2019-04-16T00:43:22.038Z"] + }, + "lastUpdatedBy": { + "type": "string", + "examples": ["5cb08d4f16640f00182c3890"] + }, + "name": { + "type": "string", + "examples": ["Device Form"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + } + } + }, + "json-forms_formSchema_container": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "readOnly": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "readOnly": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file."] + }, + "format": { + "type": "string", + "const": "data-url" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": { + "type": "boolean" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + } + } + } + }, + "anyOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "oneOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "allOf": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["type", "title"] + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": ["Is a timeout allowed to pass this step?"] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file."] + }, + "format": { + "type": "string", + "const": "data-url" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": { + "type": "boolean" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "readOnly": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file."] + }, + "format": { + "type": "string", + "const": "data-url" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + } + }, + "items": {}, + "anyOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "oneOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "allOf": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["type", "title"] + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + } + } + }, + "anyOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "oneOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "allOf": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["type", "title"] + }, + "json-forms_formStruct": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "projectId": { + "type": "string" + }, + "type": { + "type": "string" + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "array" + } + ] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "This section describes the connection information for a device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": [ + "Enter connection retry attempt count" + ] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + }, + "collapsed": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "schemaOption": { + "type": "boolean" + }, + "combinationType": { + "type": "string" + }, + "widget": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "items"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": ["Is a timeout allowed to pass this step?"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "required": ["type", "items"], + "additionalProperties": false + }, + "json-forms_formUISchema_container": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "ui:widget": { + "type": "string", + "const": "updown" + } + }, + "required": ["ui:widget"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's config"] + }, + "ui:widget": { + "type": "string", + "const": "textarea" + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Select device"] + } + } + } + ] + } + } + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "ui:widget": { + "type": "string", + "const": "updown" + } + }, + "required": ["ui:widget"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's config"] + }, + "ui:widget": { + "type": "string", + "const": "textarea" + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Select device"] + } + } + } + ] + } + } + }, + "json-forms_formValidationSchema_validationSchema": { + "type": "object" + }, + "json-forms_metaSchema": { + "oneOf": [ + { + "type": "boolean", + "default": true + }, + { + "type": "object", + "properties": { + "$id": { + "type": "string", + "format": "uri-reference" + }, + "$schema": { + "type": "string", + "format": "uri" + }, + "$ref": { + "type": "string", + "format": "uri-reference" + }, + "$comment": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "default": {}, + "readOnly": { + "type": "boolean", + "default": false + }, + "examples": { + "type": "array", + "items": {} + }, + "multipleOf": { + "type": "number", + "exclusiveMinimum": 0 + }, + "maximum": { + "type": "number" + }, + "exclusiveMaximum": { + "type": "number" + }, + "minimum": { + "type": "number" + }, + "exclusiveMinimum": { + "type": "number" + }, + "maxLength": { + "type": "integer", + "minimum": 0 + }, + "minLength": { + "allOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "default": 0 + } + ] + }, + "pattern": { + "type": "string", + "format": "regex" + }, + "additionalItems": {}, + "items": { + "anyOf": [ + {}, + { + "type": "array", + "minItems": 1, + "items": {} + } + ], + "default": true + }, + "maxItems": { + "type": "integer", + "minimum": 0 + }, + "minItems": { + "allOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "default": 0 + } + ] + }, + "uniqueItems": { + "type": "boolean", + "default": false + }, + "contains": {}, + "maxProperties": { + "type": "integer", + "minimum": 0 + }, + "minProperties": { + "allOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "default": 0 + } + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "uniqueItems": true, + "default": [] + }, + "additionalProperties": {}, + "definitions": { + "type": "object", + "additionalProperties": {}, + "default": {} + }, + "properties": { + "type": "object", + "additionalProperties": {}, + "default": {} + }, + "patternProperties": { + "type": "object", + "additionalProperties": {}, + "propertyNames": { + "format": "regex" + }, + "default": {} + }, + "dependencies": { + "type": "object", + "additionalProperties": { + "anyOf": [ + {}, + { + "type": "array", + "items": { + "type": "string" + }, + "uniqueItems": true, + "default": [] + } + ] + } + }, + "propertyNames": {}, + "const": {}, + "enum": { + "type": "array", + "items": {}, + "minItems": 1, + "uniqueItems": true + }, + "type": { + "anyOf": [ + { + "enum": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + { + "type": "array", + "items": { + "enum": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "minItems": 1, + "uniqueItems": true + } + ] + }, + "format": { + "type": "string" + }, + "contentMediaType": { + "type": "string" + }, + "contentEncoding": { + "type": "string" + }, + "if": {}, + "then": {}, + "else": {}, + "allOf": { + "type": "array", + "minItems": 1, + "items": {} + }, + "anyOf": { + "type": "array", + "minItems": 1, + "items": {} + }, + "oneOf": { + "type": "array", + "minItems": 1, + "items": {} + }, + "not": {} + } + } + ] + }, + "workflow_builder_workflowDocument": { + "title": "workflow document", + "description": "A workflow document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + "name": { + "type": "string", + "examples": ["My Workflow"] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + } + } + } + } + } + ] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + }, + "workflow_end": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "x": { + "type": "number", + "examples": [10] + }, + "y": { + "type": "number", + "examples": [20] + } + } + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "additionalProperties": false + }, + "errorHandler": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + ] + }, + "font_size": { + "type": "integer", + "default": 12, + "multipleOf": 2, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time" + }, + "created_by": {}, + "createdVersion": { + "type": "string", + "examples": ["5.40.5-2021.1.72.0"] + }, + "last_updated": { + "type": "string", + "format": "date-time" + }, + "last_updated_by": {}, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "canvasVersion": { + "type": "number", + "enum": [1, 1.5, 2, 3] + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + }, + "inputSchema": { + "type": "object" + }, + "outputSchema": { + "type": "object" + }, + "outputData": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "taskId": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$" + }, + "taskPointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "additionalProperties": false, + "required": ["name", "type", "tasks", "transitions", "groups"] + }, + "workflow_builder_workflowDocument_workflowName": { + "type": "string", + "examples": ["My Workflow"] + }, + "workflow_builder_workflowDocument_anyTask": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + } + ] + }, + "workflow_builder_workflowPayload": { + "title": "workflow import payload", + "description": "A workflow import payload, that has expanded users and groups for transportation between environments", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + "name": { + "type": "string", + "examples": ["ciscoIOSSoftwareUpgrade", "infobloxCreateARecord"] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": [ + "Upgrade Cisco IOS device", + "Infoblox Create A Record" + ] + } + ] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string", + "examples": ["New Relic", "Cisco", "AWS/EC2"] + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + } + } + } + } + } + ] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + }, + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + }, + "workflow_end": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + }, + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string" + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "additionalProperties": false + }, + "errorHandler": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + ] + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": { + "oneOf": [ + { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["username", "provenance"] + }, + { + "type": "null" + } + ] + }, + "createdVersion": { + "type": "string", + "examples": ["5.40.5-2021.1.72.0"] + }, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": { + "oneOf": [ + { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["username", "provenance"] + }, + { + "type": "null" + } + ] + }, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": ["_id", "name", "description"] + } + }, + "canvasVersion": { + "type": "number", + "enum": [1, 1.5, 2, 3] + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + }, + "inputSchema": { + "type": "object" + }, + "outputSchema": { + "type": "object" + }, + "outputData": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "taskId": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$" + }, + "taskPointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + }, + "migrationVersion": { + "type": "integer", + "minimum": 0 + } + }, + "additionalProperties": false, + "required": ["name", "type", "tasks", "transitions", "groups"] + }, + "template_builder_parseTemplateInput": { + "title": "parse template input", + "description": "The text data to be parse and the textfsm template", + "type": "object", + "properties": { + "text": { + "type": "string", + "examples": ["hostname"] + }, + "template": { + "title": "template document", + "description": "A template document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "name": { + "type": "string", + "examples": ["My Template"] + }, + "device": { + "type": "string", + "examples": ["Device Group A"] + }, + "command": { + "type": "string", + "examples": ["show hostname"] + }, + "template": { + "type": "string", + "examples": [ + "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record" + ] + }, + "text": { + "type": "string", + "examples": ["hostname"] + }, + "type": { + "type": "string", + "const": "custom" + } + }, + "required": [ + "name", + "device", + "command", + "template", + "text", + "type" + ], + "definitions": { + "templateName": { + "type": "string", + "examples": ["My Template"] + }, + "groupName": { + "type": "string", + "examples": ["Device Group A"] + }, + "command": { + "type": "string", + "examples": ["show hostname"] + }, + "template": { + "type": "string", + "examples": [ + "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record" + ] + }, + "text": { + "type": "string", + "examples": ["hostname"] + }, + "ObjectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + "required": ["text", "template"] + }, + "operations-manager_automation-api": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Automation Document", + "description": "An Automation document in API response format.", + "required": [ + "name", + "description", + "componentType", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "_id", + "gbac" + ], + "oneOf": [ + { + "required": ["componentId"], + "not": { + "required": ["componentName"] + } + }, + { + "required": ["componentName"], + "not": { + "required": ["componentId"] + } + }, + { + "required": ["componentId", "componentName"] + } + ], + "propertyNames": { + "anyOf": [ + { + "enum": ["name", "description", "componentType"] + }, + { + "enum": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] + }, + { + "enum": ["_id", "gbac", "componentName", "componentId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group ids that have write access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "read": { + "type": "array", + "description": "An array of group ids that have read/execute access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "componentId": { + "description": "The id of the component linked to this Automation.", + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + }, + { + "const": "" + } + ] + }, + "componentName": { + "description": "The name of the component linked to this Automation.", + "oneOf": [ + { + "type": "string", + "examples": ["addDuration", "getJobMetrics"] + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + "operations-manager_automation-common_commonFields": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + "operations-manager_automation-common_gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group ids that have write access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "read": { + "type": "array", + "description": "An array of group ids that have read/execute access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "operations-manager_automation-common_componentId": { + "description": "The id of the component linked to this Automation.", + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + }, + { + "const": "" + } + ] + }, + "operations-manager_automation-create": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Automation Create", + "description": "The format of accepted input for the creation of an Automation document.", + "required": ["name"], + "propertyNames": { + "anyOf": [ + { + "enum": ["name", "description", "componentType"] + }, + { + "enum": [ + "gbac", + "componentId", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy", + "componentName" + ] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group ids that have write access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "read": { + "type": "array", + "description": "An array of group ids that have read/execute access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "componentId": { + "description": "The id of the component linked to this Automation.", + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + }, + { + "const": "" + } + ] + } + } + } + ] + }, + "operations-manager_automation-json": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Automation Document", + "description": "An Automation document in JSON/export format.", + "required": [ + "name", + "description", + "componentType", + "_id", + "gbac", + "componentName" + ], + "propertyNames": { + "anyOf": [ + { + "enum": ["name", "description", "componentType"] + }, + { + "enum": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] + }, + { + "enum": ["_id", "gbac", "triggers", "componentName"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group objects that have write access to the Automation.", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "examples": ["ldap", "localAAA"] + }, + "name": { + "type": "string", + "examples": ["operators", "admins", "designers"] + }, + "description": { + "type": "string", + "examples": ["Description of a group"] + } + }, + "required": ["provenance", "name", "description"] + } + }, + "read": { + "type": "array", + "description": "An array of group objects that have read/execute access to the Automation.", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "examples": ["ldap", "localAAA"] + }, + "name": { + "type": "string", + "examples": ["operators", "admins", "designers"] + }, + "description": { + "type": "string", + "examples": ["Description of a group"] + } + }, + "required": ["provenance", "name", "description"] + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "triggers": { + "type": "array", + "items": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger", + "description": "An Endpoint Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "verb", + "routeName", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger", + "description": "An EventSystem Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "source", + "topic", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "source", + "topic", + "schema", + "legacyWrapper" + ] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger", + "description": "A Manual Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "formData", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper" + ] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Triggers Schema for JSON Representation", + "description": "Schema for a Schedule Trigger JSON representation", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "formData", + "firstRunAt", + "processMissedRuns", + "repeatUnit", + "repeatFrequency", + "repeatInterval", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": [ + "repeating", + "terminating" + ] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [ + 30, 140, 2000 + ] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [ + 10000, 30000, 100000 + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [ + 30, 140, 2000 + ] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [ + 10000, 30000, 100000 + ] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + } + }, + "componentName": { + "description": "The name of the component linked to this Automation.", + "oneOf": [ + { + "type": "string", + "examples": ["addDuration", "getJobMetrics"] + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + "operations-manager_automation-update": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Automation Updates", + "description": "The format of accepted input for an update operation on an Automation document.", + "propertyNames": { + "anyOf": [ + { + "enum": ["name", "description", "componentType"] + }, + { + "enum": [ + "gbac", + "componentId", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy", + "componentName" + ] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group ids that have write access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "read": { + "type": "array", + "description": "An array of group ids that have read/execute access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "componentId": { + "description": "The id of the component linked to this Automation.", + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + }, + { + "const": "" + } + ] + } + } + } + ] + }, + "operations-manager_common-api_pagination-metadata": { + "description": "Properties describing search result pagination", + "type": "object", + "properties": { + "skip": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "nextPageSkip": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "integer" + } + ] + }, + "previousPageSkip": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "integer" + } + ] + }, + "currentPageSize": { + "type": "integer" + } + } + }, + "operations-manager_common-api_success-response": { + "description": "A success response from an API method", + "type": "object", + "additionalProperties": false, + "required": ["message", "data", "metadata"], + "properties": { + "message": { + "description": "A human-readable message summarizing the result of the operation", + "type": "string", + "examples": [ + "Successfully created the requested item", + "Successfully imported 3 of 4 documents", + "Successfully retrieved search results", + "Successfully added group 679cebd0502a4abd9a57a6ba to job 13861e352afe454d89cccfb8", + "Successfully canceled all jobs" + ] + }, + "data": { + "description": "Any successfully retrieved information related to the request." + }, + "metadata": { + "description": "Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.", + "type": "object", + "additionalProperties": true + } + } + }, + "operations-manager_common-api_getJobsQueryParameters": { + "title": "getJobsQueryParameters", + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + }, + "skip": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + }, + "order": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + }, + "sort": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + }, + "include": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + }, + "exclude": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + }, + "in": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string" + }, + "not-in": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string" + }, + "equals": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string" + }, + "contains": { + "description": "Returns results where the specified fields contain the given match string(s). When used on the 'description' field, returns results containing any matching whole word, delimited by most punctuation. Double-quotes may be used to match phrases rather than individual words.", + "type": "string" + }, + "starts-with": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string" + }, + "ends-with": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string" + }, + "dereference": { + "description": "Designates foreign key fields to dereference in the API output.", + "type": "string" + }, + "gt": { + "description": "Returns results where the specified fields have values greater than the specified values.", + "type": "string" + }, + "gte": { + "description": "Returns results where the specified fields have values greater than or equal to the specified values.", + "type": "string" + }, + "lt": { + "description": "Returns results where the specified fields have values less than the specified values.", + "type": "string" + }, + "lte": { + "description": "Returns results where the specified fields have values less than or equal to the specified values.", + "type": "string" + }, + "q": { + "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", + "type": "string" + }, + "exists": { + "description": "Returns results where the specified fields exist according to the specified value.", + "type": "string" + } + } + }, + "operations-manager_common-api_simplePluralSearchQueryParameters": { + "type": "object", + "properties": { + "contains": { + "type": "string", + "examples": ["event"], + "description": "The value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document" + }, + "containsField": { + "type": "string", + "examples": ["name"], + "description": "The field to run a contains query on" + }, + "equals": { + "type": "string", + "examples": ["my event trigger"], + "description": "The value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document" + }, + "equalsField": { + "type": "string", + "examples": ["name"], + "description": "The field to run an equals query on" + }, + "startsWith": { + "type": "string", + "examples": ["my"], + "description": "The value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document" + }, + "startsWithField": { + "type": "string", + "examples": ["name"], + "description": "The field to run a startsWith query on" + }, + "limit": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + }, + "skip": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + }, + "order": { + "type": "integer", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "default": 1, + "enum": [-1, 1] + }, + "sort": { + "type": "string", + "description": "Field to sort by. Default is name.", + "default": "name", + "enum": ["name"] + } + } + }, + "operations-manager_common_name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "operations-manager_common_ObjectIdLikeString": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "operations-manager_common_uuid-v4": { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + "operations-manager_common_decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "operations-manager_common_metadataFields": { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "operations-manager_eventSystem-trigger-common_source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "operations-manager_eventSystem-trigger-common_topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "operations-manager_job-api": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Job Document", + "description": "A Job document in API response format.", + "$comment": "No required fields, because projection operators can result in any combination of fields", + "required": [], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "_id", + "font_size", + "type", + "created", + "last_updated", + "createdVersion", + "lastUpdatedVersion", + "canvasVersion", + "encodingVersion", + "migrationVersion", + "name", + "description", + "preAutomationTime", + "sla", + "decorators", + "transitions", + "status", + "variables", + "tags", + "error", + "warnings", + "ancestors", + "validationErrors", + "namespace" + ] + }, + { + "enum": [ + "created_by", + "last_updated_by", + "tasks", + "parent", + "errorHandler", + "groups", + "watchers", + "metrics", + "output", + "outputData", + "errors", + "warnings" + ] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "font_size": { + "type": "integer", + "examples": [12, 13, 14] + }, + "type": { + "enum": ["automation", "resource:action", "resource:compliance"] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "last_updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "createdVersion": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$", + "examples": ["5.55.5"] + }, + "lastUpdatedVersion": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$", + "examples": ["5.55.6"] + }, + "canvasVersion": { + "enum": [1, 1.5, 2, 3] + }, + "encodingVersion": { + "enum": [1] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "oneOf": [ + { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "number", + "examples": [0] + }, + "sla": { + "type": "number", + "examples": [0] + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "transitions": { + "type": "object" + }, + "status": { + "enum": [ + "error", + "complete", + "running", + "canceled", + "incomplete", + "paused" + ] + }, + "variables": { + "type": "object", + "examples": [ + { + "initiator": { + "location": "job_data", + "_id": "67be20c2dda0df69ebe60826" + }, + "_id": { + "location": "job_data", + "_id": "67be20c2dda0df69ebe60825" + } + } + ] + }, + "tags": { + "type": "array" + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "const": "job" + }, + { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["workflow_start", "e28f", "3a1f"] + } + ] + } + ] + }, + "message": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + } + ] + }, + "timestamp": { + "type": "number", + "description": "The time at which this error occurred, designated by a unix timestamp" + } + }, + "examples": [ + { + "task": "f9a9", + "message": { + "code": 500, + "message": { + "apiVersion": "1", + "method": "transformations.run", + "error": { + "code": 500, + "message": "Missing one of the following required instances: arg2, arg1", + "errors": [{}] + } + } + }, + "timestamp": 1627323002561 + }, + { + "task": "job", + "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", + "timestamp": 1627323002574 + } + ] + } + }, + "warnings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["workflow_start", "e28f", "3a1f"] + } + ] + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "message": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + } + ] + } + } + } + }, + "ancestors": { + "oneOf": [ + { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "type": "null" + } + ] + }, + "validationErrors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "keyword": { + "type": "string" + }, + "instancePath": { + "type": "string" + }, + "schemaPath": { + "type": "string" + }, + "params": { + "type": "object" + }, + "message": { + "type": "string" + } + } + } + }, + "namespace": { + "type": "object" + } + } + }, + { + "type": "object", + "properties": { + "created_by": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + "last_updated_by": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "workflow_start" + }, + "summary": { + "const": "workflow_start" + }, + "taskId": { + "const": "workflow_start" + }, + "metrics": { + "type": "object", + "properties": { + "start_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "metrics": { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + } + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + }, + "workflow_end": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "workflow_end" + }, + "summary": { + "const": "workflow_end" + }, + "taskId": { + "const": "workflow_end" + }, + "endTasks": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "metrics": { + "type": "object", + "properties": { + "end_time": { + "type": "number" + }, + "run_time": { + "type": "number" + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "operation" + }, + "canvasName": { + "not": { + "const": "childJob" + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + }, + { + "type": "object", + "properties": { + "actor": { + "oneOf": [ + { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + { + "const": "job" + } + ] + }, + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "allOf": [ + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "view": { + "type": "string" + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "automatic" + }, + "actor": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "const": "job" + }, + { + "$comment": "Job variable", + "type": "string", + "pattern": "^\\$var\\.job\\.[a-zA-Z_0-9]{1,}$" + }, + { + "$comment": "Task reference", + "type": "string", + "pattern": "^\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + } + ] + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "operation" + }, + "canvasName": { + "not": { + "const": "childJob" + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "canvasName": { + "const": "childJob" + }, + "loop": { + "type": "object", + "properties": { + "atLeastOneComplete": { + "type": "boolean" + }, + "finishedCount": { + "type": "number" + }, + "isFinished": { + "type": "object", + "additionalProperties": false, + "patternProperties": { + "^[0-9a-fA-F]{24}$": { + "type": "boolean" + } + } + }, + "outgoing": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "childJobLoopIndex": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "value": { + "type": "integer" + } + } + }, + "_id": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "_id": { + "type": "string" + } + } + }, + "initiator": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "_id": { + "type": "string" + } + } + } + } + }, + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + }, + "childJobs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "iteration": { + "type": "number" + } + } + } + } + } + } + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor": { + "oneOf": [ + { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + { + "const": "job" + } + ] + }, + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + } + } + }, + "parent": { + "type": "object", + "properties": { + "job": { + "oneOf": [ + { + "type": "string", + "examples": ["fe7043ac41d24206aa556c49"] + }, + { + "type": "object", + "description": "A single job-api object without a parent.job of type object" + } + ] + }, + "task": { + "type": "string", + "examples": ["defc"] + }, + "iteration": { + "type": "number", + "examples": [1] + }, + "element": { + "type": "number", + "examples": [0] + } + } + }, + "errorHandler": { + "oneOf": [ + { + "type": "null" + }, + { + "allOf": [ + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "view": { + "type": "string" + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "automatic" + }, + "actor": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "const": "job" + }, + { + "$comment": "Job variable", + "type": "string", + "pattern": "^\\$var\\.job\\.[a-zA-Z_0-9]{1,}$" + }, + { + "$comment": "Task reference", + "type": "string", + "pattern": "^\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + } + ] + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "operation" + }, + "canvasName": { + "not": { + "const": "childJob" + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "canvasName": { + "const": "childJob" + }, + "loop": { + "type": "object", + "properties": { + "atLeastOneComplete": { + "type": "boolean" + }, + "finishedCount": { + "type": "number" + }, + "isFinished": { + "type": "object", + "additionalProperties": false, + "patternProperties": { + "^[0-9a-fA-F]{24}$": { + "type": "boolean" + } + } + }, + "outgoing": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "childJobLoopIndex": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "value": { + "type": "integer" + } + } + }, + "_id": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "_id": { + "type": "string" + } + } + }, + "initiator": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "_id": { + "type": "string" + } + } + } + } + }, + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + }, + "childJobs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "iteration": { + "type": "number" + } + } + } + } + } + } + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor": { + "oneOf": [ + { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + { + "const": "job" + } + ] + }, + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + } + ] + }, + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "watchers": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + } + }, + "metrics": { + "allOf": [ + { + "type": "object", + "properties": { + "start_time": { + "type": "number" + }, + "progress": { + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "end_time": { + "type": "number" + } + } + }, + { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + "owner": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + "output": { + "type": "object" + }, + "outputData": { + "type": "object" + } + } + } + ] + }, + "operations-manager_job-common_taskId": { + "oneOf": [ + { + "enum": ["workflow_start", "workflow_end", "error_handler"] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["workflow_start", "e28f", "3a1f"] + } + ] + }, + "operations-manager_task-api": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Task Document", + "description": "A Task document in API response format.", + "$comment": "No required fields, because projection operators can result in any combination of fields", + "required": [], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "_id", + "location", + "view", + "status", + "app", + "name", + "variables", + "last_updated", + "encodingVersion", + "job", + "incomingRefs" + ] + }, + { + "enum": ["groups", "type", "metrics", "incomingRefs"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + "location": { + "enum": ["Adapter", "Application", "Broker"] + }, + "view": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["/workflow_engine/task/ViewData"] + } + ] + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "app": { + "type": "string", + "examples": ["WorkFlowEngine"] + }, + "name": { + "type": "string", + "examples": ["ViewData", "Stub", "Eval"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "last_updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "encodingVersion": { + "enum": [1] + }, + "job": { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "task": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["e28f", "3a1f", "b4f"] + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["View Task Data"] + } + ] + }, + "ancestors": { + "oneOf": [ + { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "type": "null" + } + ] + } + } + }, + "incomingRefs": { + "type": "array" + } + } + }, + { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "metrics": { + "allOf": [ + { + "type": "object", + "properties": { + "start_time": { + "type": "string", + "example": ["2025-03-11T19:03:31.515Z"] + }, + "claim_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number", + "examples": [1740438512495] + }, + "server_id": { + "type": "string", + "examples": [ + "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" + ] + }, + "finish_state": { + "oneOf": [ + { + "const": "success" + }, + { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + } + ] + }, + "run_time": { + "type": "number", + "examples": [5] + } + } + }, + { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + }, + "owner": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + } + } + } + ] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "operation" + }, + "metrics": { + "allOf": [ + { + "type": "object", + "properties": { + "start_time": { + "type": "string", + "example": ["2024-03-11T19:03:31.515Z"] + }, + "end_time": { + "type": "number", + "example": [1740438512495] + }, + "server_id": { + "type": "string", + "examples": [ + "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" + ] + }, + "finish_state": { + "oneOf": [ + { + "const": "success" + }, + { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + } + ] + }, + "run_time": { + "type": "number", + "examples": [6] + }, + "retrying": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + }, + "owner": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + } + } + } + ] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "automatic" + }, + "metrics": { + "allOf": [ + { + "type": "object", + "properties": { + "start_time": { + "type": "string", + "example": ["2024-03-11T19:03:31.515Z"] + }, + "end_time": { + "type": "number", + "example": [1740438512495] + }, + "server_id": { + "type": "string", + "examples": [ + "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" + ] + }, + "finish_state": { + "oneOf": [ + { + "const": "success" + }, + { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + } + ] + }, + "run_time": { + "type": "number", + "examples": [6] + }, + "retrying": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + }, + "owner": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + } + } + } + ] + } + } + } + ] + } + ] + }, + "operations-manager_task-common_taskId": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["e28f", "3a1f", "b4f"] + }, + "operations-manager_trigger-api": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger", + "description": "An Endpoint Trigger in API response format.", + "required": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "lastExecuted", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "verb", + "routeName", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger", + "description": "An EventSystem Trigger in API response format.", + "required": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "lastExecuted", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "source", + "topic", + "schema", + "legacyWrapper", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["source", "topic", "schema", "legacyWrapper"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger", + "description": "A Manual Trigger in API response format.", + "required": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "lastExecuted", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "formData", + "legacyWrapper", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["formData", "formSchemaHash", "legacyWrapper"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Trigger", + "description": "A Schedule Trigger in API response format.", + "required": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "lastExecuted", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "formData", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "processMissedRuns", + "locked", + "repeatUnit", + "repeatFrequency", + "repeatInterval", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": ["repeating", "terminating"] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + }, + "operations-manager_trigger-common_commonFields": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "operations-manager_trigger-create": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger Create", + "description": "The format of accepted input for the creation of an Endpoint Trigger.", + "required": ["name", "type", "routeName"], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger Create", + "description": "The format of accepted input for the creation of an EventSystem Trigger.", + "required": ["name", "type", "topic"], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["source", "topic", "schema", "legacyWrapper"] + }, + { + "enum": ["jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger Create", + "description": "The format of accepted input for the creation of a Manual Trigger.", + "required": ["name", "type"], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["formData", "formSchemaHash", "legacyWrapper"] + }, + { + "enum": ["formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Trigger Create", + "description": "The format of accepted input for the creation of a Schedule Trigger.", + "required": ["name", "type", "processMissedRuns"], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["formId"] + } + ] + }, + "oneOf": [ + { + "required": ["repeatUnit", "repeatFrequency"] + }, + { + "not": { + "required": ["repeatUnit", "repeatFrequency"] + } + } + ], + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": ["repeating", "terminating"] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + }, + "operations-manager_trigger-json": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger", + "description": "An Endpoint Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "verb", + "routeName", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger", + "description": "An EventSystem Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "source", + "topic", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["source", "topic", "schema", "legacyWrapper"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger", + "description": "A Manual Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "formData", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["formData", "formSchemaHash", "legacyWrapper"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Triggers Schema for JSON Representation", + "description": "Schema for a Schedule Trigger JSON representation", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "formData", + "firstRunAt", + "processMissedRuns", + "repeatUnit", + "repeatFrequency", + "repeatInterval", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": ["repeating", "terminating"] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + }, + "operations-manager_trigger-update": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger Updates", + "description": "The format of accepted input for an update operation on an Endpoint Trigger.", + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger Updates", + "description": "The format of accepted input for an update operation on an EventSystem Trigger.", + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": ["source", "topic", "schema", "legacyWrapper"] + }, + { + "enum": ["jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger Updates", + "description": "The format of accepted input for an update operation on a Manual Trigger.", + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": ["formData", "formSchemaHash", "legacyWrapper"] + }, + { + "enum": ["formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Trigger Updates", + "description": "The format of accepted input for an update operation on a Schedule Trigger.", + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["formId"] + } + ] + }, + "oneOf": [ + { + "required": ["repeatUnit", "repeatFrequency"] + }, + { + "not": { + "required": ["repeatUnit", "repeatFrequency"] + } + } + ], + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": ["repeating", "terminating"] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + }, + "mop_mopAnalyticTemplateDoc": { + "title": "mop analytic template", + "description": "A mop analytic template object", + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + "os": { + "type": "string", + "examples": ["cisco-ios"] + }, + "passRule": { + "type": "boolean" + }, + "prepostCommands": { + "type": "array", + "items": { + "type": "object", + "properties": { + "preRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "postRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "passRule": { + "type": "boolean" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["regex"] + }, + "preRegex": { + "type": "string", + "examples": [""] + }, + "postRegex": { + "type": "string", + "examples": [""] + }, + "evaluation": { + "type": "string", + "examples": ["="] + } + } + } + }, + "preCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + }, + "postCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + } + } + } + }, + "created": { + "type": "integer", + "examples": [1508182880981] + }, + "createdBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + }, + "lastUpdated": { + "type": "integer", + "examples": [1508182880981] + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + } + }, + "required": ["name"] + }, + "mop_mopAnalyticTemplateDoc__id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "mop_mopAnalyticTemplateDoc_name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "mop_mopAnalyticTemplateDoc_successResponse": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "n": { + "type": "integer", + "examples": [1] + }, + "ok": { + "type": "integer", + "examples": [1] + } + } + }, + "ops": { + "type": "array", + "items": { + "title": "mop analytic template", + "description": "A mop analytic template object", + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + "os": { + "type": "string", + "examples": ["cisco-ios"] + }, + "passRule": { + "type": "boolean" + }, + "prepostCommands": { + "type": "array", + "items": { + "type": "object", + "properties": { + "preRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "postRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "passRule": { + "type": "boolean" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["regex"] + }, + "preRegex": { + "type": "string", + "examples": [""] + }, + "postRegex": { + "type": "string", + "examples": [""] + }, + "evaluation": { + "type": "string", + "examples": ["="] + } + } + } + }, + "preCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + }, + "postCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + } + } + } + }, + "created": { + "type": "integer", + "examples": [1508182880981] + }, + "createdBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + }, + "lastUpdated": { + "type": "integer", + "examples": [1508182880981] + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + } + }, + "required": ["name"], + "definitions": { + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "projectNamespace": { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "_id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "prepostCommand": { + "type": "object", + "properties": { + "preRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "postRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "passRule": { + "type": "boolean" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["regex"] + }, + "preRegex": { + "type": "string", + "examples": [""] + }, + "postRegex": { + "type": "string", + "examples": [""] + }, + "evaluation": { + "type": "string", + "examples": ["="] + } + } + } + }, + "preCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + }, + "postCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + } + } + }, + "successResponse": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "n": { + "type": "integer", + "examples": [1] + }, + "ok": { + "type": "integer", + "examples": [1] + } + } + }, + "ops": { + "type": "array", + "items": {} + }, + "insertedCount": { + "type": "integer", + "examples": [1] + }, + "insertedIds": { + "type": "object", + "properties": { + "0": { + "type": "string", + "examples": ["TestAnalysisTemp"] + } + } + } + } + } + } + } + }, + "insertedCount": { + "type": "integer", + "examples": [1] + }, + "insertedIds": { + "type": "object", + "properties": { + "0": { + "type": "string", + "examples": ["TestAnalysisTemp"] + } + } + } + } + }, + "mop_mopTemplateDoc": { + "title": "mop template", + "description": "A mop template object", + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + "os": { + "type": "string", + "examples": ["cisco-ios"] + }, + "passRule": { + "type": "boolean" + }, + "commands": { + "type": "array", + "items": { + "type": "object", + "properties": { + "command": { + "type": "string", + "examples": ["show running-config ip vrf"] + }, + "passRule": { + "type": "boolean" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "type": "string", + "examples": ["show version"] + }, + "eval": { + "type": "string", + "examples": ["contains"] + }, + "raw": { + "type": "string", + "examples": ["show version"] + }, + "result": { + "type": "boolean" + } + }, + "required": ["rule", "eval"] + } + } + } + } + }, + "created": { + "type": "integer", + "examples": [1508182880981] + }, + "createdBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + }, + "lastUpdated": { + "type": "integer", + "examples": [1508182880981] + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + } + }, + "required": ["name"] + }, + "mop_mopTemplateDoc__id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "mop_mopTemplateDoc_name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "mop_mopTemplateDoc_successResponse": { + "type": "object", + "properties": { + "n": { + "type": "integer", + "examples": [1] + }, + "ok": { + "type": "integer", + "examples": [1] + }, + "nModified": { + "type": "integer", + "examples": [1] + } + } + }, + "mop_mopTemplateDoc_variables": { + "type": "object", + "properties": {}, + "examples": [ + { + "device_name": "my-device1" + } + ] + }, + "mop_mopTemplateDoc_devices": { + "type": "array", + "items": { + "type": "string", + "examples": ["Device 2", "Device 1"] + } + }, + "mop_mopTemplateDoc_runCommandRes": { + "type": "object", + "properties": { + "raw": { + "type": "string", + "examples": ["show version"] + }, + "all_pass_flag": { + "type": "boolean" + }, + "evaluated": { + "type": "string", + "examples": ["show version"] + }, + "parameters": { + "type": "object", + "properties": {} + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "type": "string", + "examples": ["show version"] + }, + "eval": { + "type": "string", + "examples": ["contains"] + }, + "raw": { + "type": "string", + "examples": ["show version"] + }, + "result": { + "type": "boolean" + } + }, + "required": ["rule", "eval"] + } + }, + "device": { + "type": "string", + "examples": ["device1"] + }, + "response": { + "type": "string", + "examples": ["version: 10.0.0"] + }, + "result": { + "type": "boolean" + } + } + }, + "mop_mopTemplateDoc_device": { + "type": "string", + "examples": ["device1"] + }, + "mop_mopTemplateDoc_options": { + "type": "object", + "properties": { + "start": { + "type": "integer", + "examples": [0] + }, + "limit": { + "type": "integer", + "examples": [25] + }, + "entity": { + "type": "string", + "examples": ["device1"] + }, + "filter": { + "type": "string", + "examples": ["filter"] + }, + "sort": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "integer", + "examples": [1] + } + } + } + } + } + }, + "mop_mopTemplateDoc_detailedDevice": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "authgroup": { + "type": "string", + "examples": ["csr-aws", "default"] + }, + "address": { + "type": "string", + "examples": ["127.0.0.1"] + }, + "port": { + "type": "string", + "examples": ["12035"] + }, + "device-type": { + "type": "string", + "examples": ["netconf"] + }, + "ned": { + "type": "string", + "examples": ["nso46"] + }, + "admin": { + "type": "boolean" + }, + "host": { + "type": "string", + "examples": ["Local Host"] + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "examples": ["Group1"] + } + } + } + }, + "lifecycle-manager_common-http_document-identifier": { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + }, + "lifecycle-manager_common-http_pagination-metadata": { + "description": "Properties describing search result pagination", + "type": "object", + "properties": { + "skip": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "nextPageSkip": { + "type": "integer" + }, + "previousPageSkip": { + "type": "integer" + }, + "currentPageSize": { + "type": "integer" + } + } + }, + "lifecycle-manager_common-http_response": { + "oneOf": [ + { + "description": "A success response from an API method", + "type": "object", + "additionalProperties": false, + "required": ["message", "data", "metadata"], + "properties": { + "message": { + "description": "A human-readable message summarizing the result of the operation", + "type": "string", + "examples": [ + "Successfully created the requested item", + "Successfully imported 3 of 4 documents", + "Successfully retrieved search results" + ] + }, + "data": { + "const": "null", + "description": "Any successfully retrieved information related to the request." + }, + "metadata": { + "description": "Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.", + "type": "object", + "additionalProperties": true + } + } + }, + { + "description": "A failure response from an API method", + "type": "object", + "additionalProperties": false, + "required": ["message", "data", "metadata"], + "properties": { + "message": { + "description": "A human-readable message summarizing the result of the operation", + "type": "string", + "examples": [ + "A server error occurred while processing this request" + ] + }, + "data": { + "const": "null", + "description": "Any successfully retrieved information related to the request. For error responses, this is always 'null'." + }, + "metadata": { + "description": "Any structured, wordy or machine-readable information related to the result of the operation. For error responses, this will always at least contain an 'errors' array, even if it is empty.", + "type": "object", + "properties": { + "errors": { + "type": "array" + } + }, + "additionalProperties": true + } + } + } + ] + }, + "lifecycle-manager_common_name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "lifecycle-manager_common_ObjectIdLikeString": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "lifecycle-manager_common_ObjectId": { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + }, + "lifecycle-manager_instance-group-create": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Resource Instance Group Create", + "description": "The format of accepted input for the creation of a Resource Instance Group document.", + "type": "object", + "allOf": [ + { + "propertyNames": { + "enum": [ + "name", + "description", + "modelId", + "type", + "lastAction", + "instances", + "filter" + ] + } + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": ["Some helpful information about the document"] + }, + "modelId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "oneOf": [ + { + "type": "object", + "not": { + "required": ["filter"] + }, + "properties": { + "type": { + "const": "manual" + }, + "instances": { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "type": "object", + "not": { + "required": ["instances"] + }, + "properties": { + "type": { + "const": "dynamic" + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "lastAction": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + }, + "created": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "updated": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + } + } + } + } + } + ] + } + ] + }, + { + "required": ["name", "modelId"] + } + ] + }, + "lifecycle-manager_instance-group-http": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Resource Instance Group Document", + "description": "A Resource Instance Group document in HTTP response format.", + "type": "object", + "allOf": [ + { + "propertyNames": { + "anyOf": [ + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["_id"] + }, + { + "enum": [ + "name", + "description", + "modelId", + "type", + "lastAction", + "instances", + "filter" + ] + } + ] + } + }, + { + "type": "object", + "required": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "object", + "properties": { + "firstname": { + "type": "string" + }, + "provenance": { + "type": "string" + }, + "username": { + "type": "string" + }, + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "object", + "properties": { + "firstname": { + "type": "string" + }, + "provenance": { + "type": "string" + }, + "username": { + "type": "string" + }, + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "required": ["_id"] + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "allOf": [ + { + "type": "object", + "required": [ + "name", + "description", + "modelId", + "type", + "lastAction" + ] + }, + { + "oneOf": [ + { + "type": "object", + "required": ["instances"] + }, + { + "type": "object", + "required": ["filter"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": ["Some helpful information about the document"] + }, + "modelId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "oneOf": [ + { + "type": "object", + "not": { + "required": ["filter"] + }, + "properties": { + "type": { + "const": "manual" + }, + "instances": { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "type": "object", + "not": { + "required": ["instances"] + }, + "properties": { + "type": { + "const": "dynamic" + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "lastAction": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + }, + "created": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "updated": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + } + } + } + } + } + ] + } + ] + }, + { + "type": "object", + "properties": { + "lastAction": { + "description": "The last action that was run against this document", + "type": "object", + "additionalProperties": false, + "required": ["_id", "executionId", "name", "type", "status"], + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "executionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": [ + "running", + "error", + "complete", + "canceled", + "paused" + ] + } + } + } + } + } + ] + }, + "lifecycle-manager_instance-group-search-params": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Resource Instance Group Search Parameters", + "description": "Search Parameters supported on the Resource Instance Group collection.", + "type": "object", + "allOf": [ + { + "type": "object", + "properties": { + "skip": { + "description": "This parameter specifies where to start the returned page of search results.", + "type": "string" + }, + "limit": { + "description": "This parameter specifies how many items to return in the search results.", + "type": "string" + } + } + }, + { + "type": "object", + "properties": { + "sort": { + "description": "This parameter specifies the field to sort the search results over.", + "type": "string", + "examples": ["name", "created"] + }, + "order": { + "description": "This parameter specifies the direction to sort the search results over.", + "enum": ["asc", "desc"] + } + } + }, + { + "properties": { + "equals": { + "type": "object", + "properties": { + "modelName": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "type": { + "enum": ["manual", "dynamic"] + }, + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "modelId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "createdBy": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "in": { + "allOf": [ + { + "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", + "type": "object", + "examples": [ + { + "stateId": "1234,53fe,0000" + }, + { + "name": "name1,name2,name3" + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "array", + "items": { + "enum": ["manual", "dynamic"] + } + }, + "lastAction": { + "type": "object", + "properties": { + "type": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + } + } + } + } + } + ] + }, + "starts-with": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + } + } + }, + "lt": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "lte": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "gt": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "gte": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "dereference": { + "description": "Comma-separated list of foreign key field types to dereference", + "const": "accounts" + } + } + } + ] + }, + "lifecycle-manager_instance-group-update": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Resource Instance Group Update", + "description": "The format of accepted input for updating a Resource Instance Group document.", + "type": "object", + "allOf": [ + { + "propertyNames": { + "allOf": [ + { + "enum": [ + "name", + "description", + "modelId", + "type", + "lastAction", + "instances", + "filter" + ] + }, + { + "enum": ["instancesToAdd", "instancesToRemove"] + } + ] + } + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": ["Some helpful information about the document"] + }, + "modelId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "oneOf": [ + { + "type": "object", + "not": { + "required": ["filter"] + }, + "properties": { + "type": { + "const": "manual" + }, + "instances": { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "type": "object", + "not": { + "required": ["instances"] + }, + "properties": { + "type": { + "const": "dynamic" + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "lastAction": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + }, + "created": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "updated": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + } + } + } + } + } + ] + } + ] + }, + { + "properties": { + "instancesToAdd": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + } + ] + } + }, + "instancesToRemove": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + } + ] + } + } + } + } + ] + }, + "lifecycle-manager_resource-action-execution-http": { + "oneOf": [ + { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "modelId", + "modelName", + "instanceId", + "instanceName", + "actionId", + "actionName", + "jobId", + "startTime", + "endTime", + "progress", + "status", + "errors", + "initiator", + "initiatorName", + "initialInstanceData", + "finalInstanceData" + ], + "properties": { + "_id": {}, + "modelId": {}, + "modelName": { + "description": "The name of the model as it was when the action was run", + "type": "string" + }, + "executionType": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + }, + "instanceId": {}, + "instanceName": { + "description": "The name of the instance as it was when the action was run", + "type": "string" + }, + "actionId": { + "description": "Identifier of the action that was run" + }, + "actionName": { + "description": "The name of the action as it was when the action was run", + "type": "string" + }, + "actionType": { + "description": "The type of the action" + }, + "jobId": { + "description": "Identifier of the job associated with the action", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "progress": { + "description": "A sequence of key points in the action describing its overall progress", + "type": "object", + "patternProperties": { + ".*": { + "description": "A record indicating a progress point in the flow of the action", + "type": "object", + "additionalProperties": false, + "required": [ + "progressType", + "status", + "error", + "_id", + "componentName", + "componentId" + ], + "properties": { + "_id": { + "description": "Uniquely identifies the progress point within the overall sequence", + "type": "string" + }, + "componentId": { + "description": "The id of the component related to the step", + "type": "string" + }, + "componentName": { + "description": "The name of the component related to the step", + "type": "string" + }, + "progressType": { + "description": "Designates what type of progress point this object describes", + "const": "resource:action" + }, + "error": { + "description": "Records any errors directly related to the components in the progress item", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "status": { + "description": "Designates the status of the progress item", + "type": "string", + "enum": ["pending", "complete", "error"] + } + } + } + } + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": ["running", "error", "complete", "canceled", "paused"] + }, + "errors": { + "description": "A list of any errors which occurred while the action was running", + "type": "array", + "items": { + "description": "A record of an error which occurred while the action was running", + "type": "object", + "properties": { + "message": { + "description": "A human-readable message summarizing the issue", + "type": "string" + }, + "origin": { + "description": "Designates where the error came from", + "type": "string", + "enum": [ + "preTransformation", + "workflow", + "postTransformation", + "finishAction", + "system" + ] + }, + "timestamp": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "metadata": { + "description": "Additional properties that help describe the issue" + }, + "stepId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + } + }, + "initiator": {}, + "initiatorName": { + "description": "The name of the user or automation trigger that initiated the action", + "type": "string" + }, + "initialInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + }, + "finalInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + } + } + }, + { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "modelId", + "modelName", + "instanceId", + "instanceName", + "actionId", + "actionName", + "parentActionExecutionId", + "jobId", + "startTime", + "endTime", + "progress", + "status", + "errors", + "initiator", + "initiatorName", + "initialInstanceData", + "finalInstanceData" + ], + "properties": { + "_id": {}, + "modelId": {}, + "modelName": { + "description": "The name of the model as it was when the action was run", + "type": "string" + }, + "executionType": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + }, + "instanceId": {}, + "instanceName": { + "description": "The name of the instance as it was when the action was run", + "type": "string" + }, + "actionId": { + "description": "Identifier of the action that was run" + }, + "actionName": { + "description": "The name of the action as it was when the action was run", + "type": "string" + }, + "actionType": { + "description": "The type of the action" + }, + "parentActionExecutionId": { + "description": "Identifier of the job associated with the action" + }, + "groupId": { + "description": "Identifier of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "groupName": { + "description": "The name of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "jobId": { + "description": "Identifier of the job associated with the action", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "progress": { + "description": "A sequence of key points in the action describing its overall progress", + "type": "object", + "patternProperties": { + ".*": { + "description": "A record indicating a progress point in the flow of the action", + "type": "object", + "additionalProperties": false, + "required": [ + "progressType", + "status", + "error", + "_id", + "componentName", + "componentId" + ], + "properties": { + "_id": { + "description": "Uniquely identifies the progress point within the overall sequence", + "type": "string" + }, + "componentId": { + "description": "The id of the component related to the step", + "type": "string" + }, + "componentName": { + "description": "The name of the component related to the step", + "type": "string" + }, + "progressType": { + "description": "Designates what type of progress point this object describes", + "const": "resource:action" + }, + "error": { + "description": "Records any errors directly related to the components in the progress item", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "status": { + "description": "Designates the status of the progress item", + "type": "string", + "enum": ["pending", "complete", "error"] + } + } + } + } + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": ["running", "error", "complete", "canceled", "paused"] + }, + "errors": { + "description": "A list of any errors which occurred while the action was running", + "type": "array", + "items": { + "description": "A record of an error which occurred while the action was running", + "type": "object", + "properties": { + "message": { + "description": "A human-readable message summarizing the issue", + "type": "string" + }, + "origin": { + "description": "Designates where the error came from", + "type": "string", + "enum": [ + "preTransformation", + "workflow", + "postTransformation", + "finishAction", + "system" + ] + }, + "timestamp": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "metadata": { + "description": "Additional properties that help describe the issue" + }, + "stepId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + } + }, + "initiator": {}, + "initiatorName": { + "description": "The name of the user or automation trigger that initiated the action", + "type": "string" + }, + "initialInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + }, + "finalInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + } + } + }, + { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "modelId", + "modelName", + "instanceIds", + "childStatuses", + "actionId", + "actionName", + "jobId", + "startTime", + "endTime", + "progress", + "status", + "errors", + "initiator", + "initiatorName" + ], + "properties": { + "_id": {}, + "modelId": {}, + "modelName": { + "description": "The name of the model as it was when the action was run", + "type": "string" + }, + "executionType": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + }, + "instanceIds": { + "description": "The IDs of the instances that are being acted upon", + "type": "array", + "items": {} + }, + "childStatuses": { + "description": "An object mapping the current status of child action executions", + "type": "object" + }, + "actionId": { + "description": "Identifier of the action that was run" + }, + "actionName": { + "description": "The name of the action as it was when the action was run", + "type": "string" + }, + "actionType": { + "description": "The type of the action" + }, + "groupId": { + "description": "Identifier of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "groupName": { + "description": "The name of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "jobId": { + "description": "Identifier of the job associated with the action", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "progress": { + "description": "A sequence of key points in the action describing its overall progress", + "type": "object", + "patternProperties": { + ".*": { + "description": "A record indicating a progress point in the flow of the action", + "type": "object", + "additionalProperties": false, + "required": [ + "progressType", + "status", + "error", + "_id", + "componentName", + "componentId" + ], + "properties": { + "_id": { + "description": "Uniquely identifies the progress point within the overall sequence", + "type": "string" + }, + "componentId": { + "description": "The id of the component related to the step", + "type": "string" + }, + "componentName": { + "description": "The name of the component related to the step", + "type": "string" + }, + "progressType": { + "description": "Designates what type of progress point this object describes", + "const": "resource:action" + }, + "error": { + "description": "Records any errors directly related to the components in the progress item", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "status": { + "description": "Designates the status of the progress item", + "type": "string", + "enum": ["pending", "complete", "error"] + } + } + } + } + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": ["running", "error", "complete", "canceled", "paused"] + }, + "errors": { + "description": "A list of any errors which occurred while the action was running", + "type": "array", + "items": { + "description": "A record of an error which occurred while the action was running", + "type": "object", + "properties": { + "message": { + "description": "A human-readable message summarizing the issue", + "type": "string" + }, + "origin": { + "description": "Designates where the error came from", + "type": "string", + "enum": [ + "preTransformation", + "workflow", + "postTransformation", + "finishAction", + "system" + ] + }, + "timestamp": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "metadata": { + "description": "Additional properties that help describe the issue" + }, + "stepId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + } + }, + "initiator": { + "oneOf": [ + { + "const": "Pronghorn" + }, + {} + ] + }, + "initiatorName": { + "type": "string" + }, + "initialInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + }, + "finalInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + } + } + } + ] + }, + "lifecycle-manager_resource-action-execution-search-params": { + "description": "Search parameters for resource action executions", + "type": "object", + "additionalProperties": false, + "required": [], + "allOf": [ + { + "type": "object", + "properties": { + "skip": { + "description": "This parameter specifies where to start the returned page of search results.", + "type": "string" + }, + "limit": { + "description": "This parameter specifies how many items to return in the search results.", + "type": "string" + } + } + }, + { + "type": "object", + "properties": { + "sort": { + "description": "This parameter specifies the field to sort the search results over.", + "type": "string", + "examples": ["name", "created"] + }, + "order": { + "description": "This parameter specifies the direction to sort the search results over.", + "enum": ["asc", "desc"] + } + } + }, + { + "type": "object", + "properties": { + "equals": { + "type": "object", + "properties": { + "_id": {}, + "modelId": {}, + "modelName": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "instanceId": {}, + "instanceName": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "groupId": {}, + "groupName": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "actionId": { + "description": "The identifier of an action" + }, + "actionName": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "jobId": {}, + "executionType": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + }, + "startTime": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "endTime": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": [ + "running", + "error", + "complete", + "canceled", + "paused" + ] + }, + "initiator": {}, + "parentActionExecutionId": {} + } + }, + "in": { + "allOf": [ + { + "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", + "type": "object", + "examples": [ + { + "stateId": "1234,53fe,0000" + }, + { + "name": "name1,name2,name3" + } + ] + }, + { + "type": "object", + "properties": { + "modelId": { + "description": "A comma-delineated list of model ids to search for", + "type": "array", + "items": {} + }, + "gruopId": { + "description": "A comma-delineated list of group ids to search for", + "type": "array", + "items": {} + }, + "status": { + "description": "A comma-delineated list of statuses to search for", + "type": "array", + "items": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": [ + "running", + "error", + "complete", + "canceled", + "paused" + ] + } + }, + "executionType": { + "description": "A comma-delineated list of execution types to search for", + "type": "array", + "items": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + } + } + } + } + ] + }, + "starts-with": { + "type": "object", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "groupName": { + "description": "The name of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "instanceName": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "actionName": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "initiatorName": { + "type": "string" + } + } + }, + "lt": { + "type": "object", + "properties": { + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + } + } + }, + "lte": { + "type": "object", + "properties": { + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + } + } + }, + "gt": { + "type": "object", + "properties": { + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + } + } + }, + "gte": { + "type": "object", + "properties": { + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + } + } + }, + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ] + }, + "lifecycle-manager_resource-instance-common_name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "lifecycle-manager_resource-instance-common_description": { + "type": "string", + "description": "Free-form text describing the resource instance", + "default": "", + "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] + }, + "lifecycle-manager_resource-instance-export": { + "type": "object", + "additionalProperties": false, + "required": [ + "name", + "description", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy", + "instanceData" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource instance", + "default": "", + "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] + }, + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource instance" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource instance" + }, + "instanceData": { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + "lifecycle-manager_resource-instance-http": { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "name", + "description", + "modelId", + "instanceData", + "lastAction", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource instance", + "default": "", + "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] + }, + "modelId": {}, + "instanceData": { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "lastAction": { + "description": "The last action that was run on this instance", + "type": "object", + "additionalProperties": false, + "required": ["_id", "executionId", "name", "type", "status"], + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "executionId": {}, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": ["running", "error", "complete", "canceled", "paused"] + } + } + }, + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource instance" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource instance" + }, + "instanceGroups": { + "description": "The groups that this resource instance is a member of", + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + } + } + } + } + } + }, + "lifecycle-manager_resource-instance-search-params": { + "type": "object", + "additionalProperties": false, + "required": [], + "allOf": [ + { + "type": "object", + "properties": { + "skip": { + "description": "This parameter specifies where to start the returned page of search results.", + "type": "string" + }, + "limit": { + "description": "This parameter specifies how many items to return in the search results.", + "type": "string" + } + } + }, + { + "type": "object", + "properties": { + "sort": { + "description": "This parameter specifies the field to sort the search results over.", + "type": "string", + "examples": ["name", "created"] + }, + "order": { + "description": "This parameter specifies the direction to sort the search results over.", + "enum": ["asc", "desc"] + } + } + }, + { + "properties": { + "equals": { + "type": "object", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "stateName": { + "description": "The name of the current state of the resource instance", + "type": "string" + }, + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "modelId": {}, + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "createdBy": {}, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + }, + "lastUpdatedBy": {} + } + }, + "in": { + "allOf": [ + { + "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", + "type": "object", + "examples": [ + { + "stateId": "1234,53fe,0000" + }, + { + "name": "name1,name2,name3" + } + ] + }, + { + "type": "object", + "properties": { + "lastAction": { + "type": "object", + "properties": { + "type": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + } + } + } + } + } + ] + }, + "include-deleted": { + "type": "string", + "default": "false", + "enum": ["true", "false"] + }, + "starts-with": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + } + } + }, + "group": { + "type": "string", + "description": "An ID or name of an instance group to filter by", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "instanceGroups": { + "type": "string", + "default": "false", + "enum": ["true", "false"] + }, + "lt": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + } + } + }, + "lte": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + } + } + }, + "gt": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + } + } + }, + "gte": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + } + } + }, + "include": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "_id", + "name", + "description", + "modelId", + "instanceData", + "lastAction", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ] + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "_id", + "name", + "description", + "modelId", + "instanceData", + "lastAction", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ] + } + }, + "dereference": { + "description": "Comma-separated list of foreign key field types to dereference", + "const": "accounts" + } + } + } + ] + }, + "lifecycle-manager_resource-model-common_name": { + "type": "string", + "description": "The name of the resource model", + "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] + }, + "lifecycle-manager_resource-model-common_action-identifier": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + }, + "lifecycle-manager_resource-model-common_action": { + "type": "object", + "required": [ + "_id", + "name", + "workflow", + "preWorkflowJst", + "postWorkflowJst", + "type" + ], + "additionalProperties": false, + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + }, + "lifecycle-manager_resource-model-common_actions": { + "type": "array", + "items": { + "type": "object", + "required": [ + "_id", + "name", + "workflow", + "preWorkflowJst", + "postWorkflowJst", + "type" + ], + "additionalProperties": false, + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + } + }, + "lifecycle-manager_resource-model-create-data": { + "type": "object", + "additionalProperties": false, + "required": ["name"], + "properties": { + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource model", + "default": "", + "examples": [ + "This resource model represents something we use on a day-to-day basis.", + "We use this to model one of the devices in our system.", + "This model tracks one of the elements of our cloud infrastructure." + ] + }, + "schema": { + "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "workflow", + "preWorkflowJst", + "postWorkflowJst", + "type" + ], + "additionalProperties": false, + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The _id of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "description": "The UUIDv4 identifying a workflow" + } + ] + } + } + } + } + } + }, + "lifecycle-manager_resource-model-export": { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "name", + "description", + "schema", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource model", + "default": "", + "examples": [ + "This resource model represents something we use on a day-to-day basis.", + "We use this to model one of the devices in our system.", + "This model tracks one of the elements of our cloud infrastructure." + ] + }, + "schema": { + "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + } + }, + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource model" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource model" + } + } + }, + "lifecycle-manager_resource-model-http": { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "name", + "description", + "schema", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource model", + "default": "", + "examples": [ + "This resource model represents something we use on a day-to-day basis.", + "We use this to model one of the devices in our system.", + "This model tracks one of the elements of our cloud infrastructure." + ] + }, + "schema": { + "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "required": [ + "_id", + "name", + "workflow", + "preWorkflowJst", + "postWorkflowJst", + "type" + ], + "additionalProperties": false, + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The _id of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "description": "The UUIDv4 identifying a workflow" + } + ] + }, + "inputSchema": { + "description": "The schema describing inputs to this action", + "type": "object" + }, + "outputSchema": { + "description": "The schema describing inputs to this action", + "type": "object" + } + } + } + }, + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource model" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource model" + } + } + }, + "lifecycle-manager_resource-model-import": { + "type": "object", + "additionalProperties": false, + "required": ["model"], + "properties": { + "model": { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "name", + "description", + "schema", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource model", + "default": "", + "examples": [ + "This resource model represents something we use on a day-to-day basis.", + "We use this to model one of the devices in our system.", + "This model tracks one of the elements of our cloud infrastructure." + ] + }, + "schema": { + "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + } + }, + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource model" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource model" + } + }, + "definitions": { + "action-workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "action": { + "type": "object", + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + } + } + } + }, + "overwrite": { + "type": "boolean" + } + } + }, + "lifecycle-manager_resource-model-search-params": { + "type": "object", + "additionalProperties": false, + "required": [], + "allOf": [ + { + "type": "object", + "properties": { + "skip": { + "description": "This parameter specifies where to start the returned page of search results.", + "type": "string" + }, + "limit": { + "description": "This parameter specifies how many items to return in the search results.", + "type": "string" + } + } + }, + { + "type": "object", + "properties": { + "sort": { + "description": "This parameter specifies the field to sort the search results over.", + "type": "string", + "examples": ["name", "created"] + }, + "order": { + "description": "This parameter specifies the direction to sort the search results over.", + "enum": ["asc", "desc"] + } + } + }, + { + "type": "object", + "properties": { + "equals": { + "type": "object", + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "starts-with": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + } + } + }, + "contains": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + } + } + }, + "lt": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "lte": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "gt": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "gte": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "dereference": { + "description": "Comma-separated list of field types to dereference", + "type": "string" + } + } + } + ] + } + }, + "securitySchemes": { + "OAuth" : { + "type" : "oauth2", + "flows" : { + "clientCredentials" : { + "tokenUrl" : "https://platform/oauth/token", + "refreshUrl" : "", + "scopes" : {} + } + } + } + } + } +} diff --git a/Itential/Platform/OpenAPISpecs/platform6.json b/Itential/Platform/OpenAPISpecs/platform6.json new file mode 100644 index 0000000..bed0786 --- /dev/null +++ b/Itential/Platform/OpenAPISpecs/platform6.json @@ -0,0 +1,79608 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Platform 6", + "description": "Platform 6 REST API for Application Integration.", + "version": "1.0.0", + "x-logo": { + "url": "https://www.itential.com/wp-content/uploads/2022/08/Color-Variation-White.png", + "backgroundColor": "#FFFFFF", + "altText": "Itential logo" + } + }, + "servers": [ + { + "url": "{protocol}://{server}:{port}", + "variables": { + "protocol": { + "default": "http", + "description": "The server protocol" + }, + "server": { + "default": "localhost", + "description": "The server IP or DNS" + }, + "port": { + "default": "3000", + "description": "The server port" + } + } + } + ], + "x-tagGroups": [ + { + "name": "Home", + "tags": ["home-about", "home-baseline"] + }, + { + "name": "Authentication", + "tags": ["auth-reqs", "auth-basic", "auth-query-token", "auth-client"] + }, + { + "name": "Getting Started", + "tags": [ + "example-whoami-basic", + "example-whoami-query-token", + "example-whoami-client-bearer-token" + ] + }, + { + "name": "API Reference", + "tags": [ + "api-reference", + "adapter-models", + "adapters", + "ag-manager", + "applications", + "authentication", + "authorization", + "automation-studio", + "configuration_manager", + "customization", + "device-counts", + "external-links", + "git", + "group-mappings", + "health", + "help", + "indexes", + "integration-models", + "integrations", + "json-forms", + "lifecycle-manager", + "mop", + "oauth", + "operations-manager", + "profiles", + "schema", + "search", + "sso", + "tags", + "template_builder", + "transformations", + "user", + "workflow_builder", + "workflow_engine" + ] + } + ], + "tags": [ + { + "name": "home-about", + "x-displayName": "About", + "description": "The Itential REST API uses OpenAPI 3.1.0 specifications and supports Basic Authentication and OAuth 2.0 to authenticate requests. This reference library documents available APIs for the Platform 6, including HTTP response codes to indicate success or failure of an API request. Platform 6 REST APIs also use standard verbs to perform CRUD operations. For product documentation, visit [Itential Documentation & Guides](https://docs.itential.com/v1/en).\n
" + }, + { + "name": "home-baseline", + "x-displayName": "Ports and Base Path", + "description": "Default HTTP port is `3000`. Default HTTPS port is `3443`. Both IPv6 and IPv4 are supported. Default host is `127.0.0.1`. The basePath is `/`.\n
\n" + }, + { + "name": "auth-reqs", + "x-displayName": "Authentication", + "description": "API requests without authentication will fail. Available authorizations include: `BasicAuth` (username/password), `CookieAuth`(token/cookie-based) and `QueryAuth` (token/query-based).\n
\n" + }, + { + "name": "auth-basic", + "x-displayName": "Basic Auth", + "description": "

This API uses Basic Authentication for securing its endpoints.

\n\n

How to Use Basic Authentication

\n

Using this authentication strategy, you need to provide your credentials in the HTTP request headers. The credentials should be sent as a base64 encoded string of username:password.

\n\n

Example: Using curl for Basic Authentication

\n
\n curl -u username:password -X GET \"https://localhost:3443\"\n
\n\n

In this example, -u is the flag used by curl to specify the username and password. Replace username and password with your actual credentials.

\n\n

HTTP Request Headers

\n

The Basic Authentication credentials are sent in the Authorization header. Here's what it looks like:

\n
\n Authorization: Basic base64(username:password)\n
\n\n

Base64 Encoding

\n

The username:password string needs to be base64 encoded before it is sent in the header. For example, if your username is user and your password is pass, the string to encode is user:pass. The base64 encoded result would look something like this:

\n
\n Authorization: Basic dXNlcjpwYXNz\n
\n" + }, + { + "name": "auth-query-token", + "x-displayName": "Query Token", + "description": "

Authentication

\n

Using this authentication strategy, you need to authenticate and obtain a token by making a POST request to the /login endpoint. The response token will be used in the token query parameter for subsequent requests.

\n\n

How to Request a Token

\n

To obtain an authentication token, send a POST request to the /login endpoint with the following JSON payload:

\n\n
\n \n {\n \"user\": {\n \"username\": \"admin\",\n \"password\": \"admin\"\n }\n }\n \n
\n\n

Example: Using curl to Request a Token

\n
\n curl -X POST \"https://localhost:3443/login\" -H \"Content-Type: application/json\" -d '{\"user\": {\"username\": \"admin\", \"password\": \"admin\"}}'\n
\n\n

In this example, the -d flag is used by curl to send the JSON body with the request.

\n\n

Response

\n

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

\n\n
\n \n your-auth-token-here\n \n
\n\n

Using the Token in Subsequent Requests

\n

Once you have the token, include it in the query string of your requests as follows:

\n\n
\n ?token=your-auth-token-here\n
\n" + }, + { + "name": "auth-client", + "x-displayName": "Client Auth", + "description": "

Authentication

\n

Using this authentication strategy, you need to authenticate and obtain a Bearer token by making a POST request to the /oauth/token endpoint. The response access_token will be used as temporary credentials that the client will set in the Authorization header. Here's what it looks like:

\n
\n Authorization: Basic access_token\n
\n\n.

\n\n

How to Request a Token

\n

To obtain an authentication token, send a POST request to the /oauth/token endpoint. You'll need to send the data as application/x-www-form-urlencoded with the following payload:

\n\n
\n client_id=your-client-id&client_secret=your-client-secret&grant_type=client_credentials\n
\n\n

Example: Using curl to Request a Bearer Token

\n
\n curl -X POST \"https://localhost:3443/oauth/token\" -H \"Content-Type: accept: application/json\" -H \"Content-Type: application/x-www-form-urlencoded\" -d 'client_id=123abccc123a123a12ab1ab1&client_secret=a123a123-a1a1-1a1a-a123-123a12abc1a1&grant_type=client_credentials'\n
\n\n

In this example, the -d flag is used by curl to send the data with the request.

\n\n

Response

\n

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

\n\n
\n\n{\n\"access_token\": \"falksjflkasdjflkasdjfklajsdflj.eyJwcmluY2lwYWxJZCI6IjY2OWU1ZGNjOTE1ZDUxMWEzMmJmMGNhNCIsImV4cCI6MTcyMTY1OTQ4MDkwMiwiaWF0IjoxNzIxNjU1ODgwfQ.7jrB2mC9aqSdPdUvz7D-u9HghRFtnpFbYdaBH54kNZc\",\"token_type\": \"bearer\",\"expires_in\": 3600}\n \n
\n\n

Using the Bearer Token in Subsequent Requests

\n

Once you have the Bearer token, use it as your Authorization header. Here's what it should look like:

\n\n
\n Authorization: Bearer your-access_token-here\n
\n" + }, + { + "name": "example-whoami-basic", + "x-displayName": "Example (whoami) - Basic Auth", + "description": "To test the API using Basic Authentication, you can use the following\n`curl` command. Replace `username` and `password` with your actual\ncredentials.\n\nNote: Basic Auth is only available over SSL.\n\n\n
\n curl -u username:password -X GET \"https://localhost:3443/whoami\"\n
\n\nThis command sends a GET request to the specified resource, using the\nprovided username and password for authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" + }, + { + "name": "example-whoami-query-token", + "x-displayName": "Example (whoami) - Query Token", + "description": "To test the API using the Query Token Authentication, you can use the following\n`curl` command. Replace `your-auth-token-here` with your actual\ntoken that you received using `/login`.\n\n\n
\n curl -X GET \"https://localhost:3443/whoami?token=your-auth-token-here\"\n
\n\nThis command sends a GET request to the specified resource, using the\nQuery Token authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" + }, + { + "name": "example-whoami-client-bearer-token", + "x-displayName": "Example (whoami) - Client Bearer Token", + "description": "To test the API using the Client Authentication, you can use the following\n`curl` command. Replace `your-access_token-here` with your actual\nBearer token that you received using `/oauth/token`.\n\n\n
\n curl -X GET \"https://localhost:3443/whoami\" -H \"Authorization: Bearer your-access_token-here\" \n
\n\nThis command sends a GET request to the specified resource, using the\nClient authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" + }, + { + "name": "adapter-models", + "x-displayName": "Adapter Models" + }, + { + "name": "adapters", + "x-displayName": "Adapters" + }, + { + "name": "ag-manager", + "x-displayName": "Automation Gateway" + }, + { + "name": "applications", + "x-displayName": "Applications" + }, + { + "name": "authentication", + "x-displayName": "Authentication" + }, + { + "name": "authorization", + "x-displayName": "Authorization" + }, + { + "name": "automation-studio", + "x-displayName": "Automation Studio", + "description": "A suite of tools for designing workflows, templates, and forms." + }, + { + "name": "configuration_manager", + "description": "Unified manager application for devices and configurations" + }, + { + "name": "configuration_manager", + "x-displayName": "Configuration Manager" + }, + { + "name": "customization", + "x-displayName": "Customization" + }, + { + "name": "device-counts", + "x-displayName": "Device Counts" + }, + { + "name": "external-links", + "x-displayName": "External Links" + }, + { + "name": "formbuilder", + "description": "API to generate dynamic forms" + }, + { + "name": "git", + "x-displayName": "Git" + }, + { + "name": "group-mappings", + "x-displayName": "Group Mappings" + }, + { + "name": "health", + "x-displayName": "Health" + }, + { + "name": "help", + "x-displayName": "Help", + "description": "Documentation Help" + }, + { + "name": "indexes", + "x-displayName": "Indexes" + }, + { + "name": "integration-models", + "x-displayName": "Integration Models" + }, + { + "name": "integrations", + "x-displayName": "Integrations" + }, + { + "name": "json-forms", + "x-displayName": "JSON Forms", + "description": "An application to create, edit, and publish forms based on JSON documents." + }, + { + "name": "lifecycle-manager", + "x-displayName": "Lifecycle Manager" + }, + { + "name": "mop", + "x-displayName": "Command Templates (MOP)" + }, + { + "name": "oauth", + "x-displayName": "OAuth" + }, + { + "name": "operations-manager", + "x-displayName": "Operations Manager" + }, + { + "name": "prebuilts", + "description": "Pre-Builts API" + }, + { + "name": "prebuilts-repository", + "description": "Pre-Builts Repository API" + }, + { + "name": "profiles", + "x-displayName": "Profiles" + }, + { + "name": "prometheus_metrics", + "x-displayName": "Prometheus Metrics" + }, + { + "name": "schema", + "x-displayName": "Schema" + }, + { + "name": "search", + "x-displayName": "Search" + }, + { + "name": "sso", + "x-displayName": "Single Sign On" + }, + { + "name": "tags", + "x-displayName": "Tags" + }, + { + "name": "template_builder", + "x-displayName": "Template Builder" + }, + { + "name": "transformations", + "x-displayName": "Transformations" + }, + { + "name": "user", + "x-displayName": "User" + }, + { + "name": "workflow_builder", + "x-displayName": "Workflow Builder" + }, + { + "name": "workflow_engine", + "x-displayName": "Workflow Engine" + } + ], + "paths": { + "/adapters": { + "post": { + "summary": "Create a new adapter.", + "description": "Create a new adapter in IAP.", + "tags": ["adapters"], + "parameters": [], + "operationId": "Adapters.createAdapter", + "responses": { + "200": { + "description": "The result of the adapter creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin"], + "CookieAuth": ["Adapters.admin"], + "BasicAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "model": { + "$ref": "#/components/schemas/iap_services-schema_model" + }, + "name": { + "$ref": "#/components/schemas/iap_services-schema_name" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "id", + "description": "The id for the service", + "const": { + "$data": "2/name" + }, + "examples": ["Local AAA"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of an adapter", + "examples": ["local_aaa", "Redis", "Email"] + }, + "properties": { + "type": "object", + "properties": {} + }, + "brokers": { + "type": "array", + "description": "Brokers which utilize this service", + "items": { + "type": "string", + "description": "Name of the broker", + "examples": ["aaa"] + } + }, + "groups": { + "type": "array", + "description": "Groups which can use this service", + "items": { + "type": "string", + "description": "Name of the group", + "examples": ["pronghorn_admin"] + } + } + }, + "required": ["id", "type"] + } + }, + "required": ["name", "type", "properties"] + } + } + } + } + } + } + }, + "get": { + "summary": "Get all adapters.", + "description": "Get all adapters in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "skipActiveSync", + "in": "query", + "description": "skipActiveSync", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + } + ], + "operationId": "Adapters.getAdapters", + "responses": { + "200": { + "description": "Contains an array of adapters and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin", "Adapters.apiread"], + "CookieAuth": ["Adapters.admin", "Adapters.apiread"], + "BasicAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": false + } + }, + "/adapters/import": { + "post": { + "summary": "Import a new adapter.", + "description": "Import a new adapter in IAP.", + "tags": ["adapters"], + "parameters": [], + "operationId": "Adapters.importAdapter", + "responses": { + "200": { + "description": "The result of the adapter import process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin"], + "CookieAuth": ["Adapters.admin"], + "BasicAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "model": { + "$ref": "#/components/schemas/iap_services-schema_model" + }, + "name": { + "$ref": "#/components/schemas/iap_services-schema_name" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "migrationVersion": { + "type": "integer", + "minimum": 0 + }, + "properties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "id", + "description": "The id for the service", + "const": { + "$data": "2/name" + }, + "examples": ["Local AAA"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of an adapter", + "examples": ["local_aaa", "Redis", "Email"] + }, + "properties": { + "type": "object", + "properties": {} + }, + "brokers": { + "type": "array", + "description": "Brokers which utilize this service", + "items": { + "type": "string", + "description": "Name of the broker", + "examples": ["aaa"] + } + }, + "groups": { + "type": "array", + "description": "Groups which can use this service", + "items": { + "type": "string", + "description": "Name of the group", + "examples": ["pronghorn_admin"] + } + } + }, + "required": ["id", "type"] + } + }, + "required": ["name", "type", "properties"] + } + } + } + } + } + } + } + }, + "/adapters/{name}": { + "delete": { + "summary": "Delete an adapter.", + "description": "Delete an adapter from IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.deleteAdapter", + "responses": { + "200": { + "description": "The output of the adapter deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin"], + "CookieAuth": ["Adapters.admin"], + "BasicAuth": ["Adapters.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a single adapter.", + "description": "Get a single adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.getAdapter", + "responses": { + "200": { + "description": "Contains the data of a single adapter.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin", "Adapters.apiread"], + "CookieAuth": ["Adapters.admin", "Adapters.apiread"], + "BasicAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an adapter.", + "description": "Update an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.updateAdapter", + "responses": { + "200": { + "description": "The output of the adapter update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin"], + "CookieAuth": ["Adapters.admin"], + "BasicAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "$ref": "#/components/schemas/iap_services-schema_properties" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/adapters/{name}/export": { + "get": { + "summary": "Export a single adapter.", + "description": "Export a single adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.exportAdapter", + "responses": { + "200": { + "description": "Contains the data of a single adapter.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin", "Adapters.apiread"], + "CookieAuth": ["Adapters.admin", "Adapters.apiread"], + "BasicAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": false + } + }, + "/adapters/{name}/changelogs": { + "get": { + "summary": "Get the list of changelogs.", + "description": "Get the list of changelogs for a specific adapter.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["WorkFlowEngine", "MOP"] + } + }, + { + "name": "release", + "in": "query", + "description": "release", + "required": false, + "schema": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + } + } + ], + "operationId": "Adapters.getAdapterChangelogs", + "responses": { + "200": { + "description": "The list of changelogs available for the requested adapter.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "string", + "examples": [ + { + "2020.1.1": "Changelog for 2020.1" + } + ], + "pattern": "^[0-9]{4}[.][0-9]{1,}[.][0-9]{1,}$" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin", "Adapters.apiread"], + "CookieAuth": ["Adapters.admin", "Adapters.apiread"], + "BasicAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": true + } + }, + "/adapters/{name}/start": { + "put": { + "summary": "Start an adapter.", + "description": "Start an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.startAdapter", + "responses": { + "200": { + "description": "The result of the start process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin"], + "CookieAuth": ["Adapters.admin"], + "BasicAuth": ["Adapters.admin"] + } + ], + "deprecated": false + } + }, + "/adapters/{name}/stop": { + "put": { + "summary": "Stop an adapter.", + "description": "Stop an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.stopAdapter", + "responses": { + "200": { + "description": "The result of the stop process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin"], + "CookieAuth": ["Adapters.admin"], + "BasicAuth": ["Adapters.admin"] + } + ], + "deprecated": false + } + }, + "/adapters/{name}/restart": { + "put": { + "summary": "Restart an adapter.", + "description": "Restart an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.restartAdapter", + "responses": { + "200": { + "description": "The result of the restart process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin"], + "CookieAuth": ["Adapters.admin"], + "BasicAuth": ["Adapters.admin"] + } + ], + "deprecated": false + } + }, + "/adapters/{name}/loglevel": { + "put": { + "summary": "Update the log levels.", + "description": "Update the log levels for an adapter.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.updateAdapterLogging", + "responses": { + "200": { + "description": "The result of updating the log levels for an adapter.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin"], + "CookieAuth": ["Adapters.admin"], + "BasicAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "transport": { + "type": "string", + "enum": ["file", "console", "syslog"] + } + }, + "if": { + "properties": { + "transport": { + "const": "syslog" + } + } + }, + "then": { + "properties": { + "level": { + "$ref": "#/components/schemas/iap_services-schema_sys_log_level" + } + } + }, + "else": { + "properties": { + "level": { + "$ref": "#/components/schemas/iap_services-schema_log_level" + } + } + } + } + } + } + } + } + } + } + }, + "/adapters/{name}/properties": { + "put": { + "summary": "Update the properties of an adapter.", + "description": "Update the properties of an adapter in IAP.", + "tags": ["adapters"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Adapters.updateAdapterProperties", + "responses": { + "200": { + "description": "The output of the adapter properties update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin"], + "CookieAuth": ["Adapters.admin"], + "BasicAuth": ["Adapters.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties" + } + } + } + } + } + } + } + }, + "/adapters/brokers/mapping": { + "get": { + "summary": "Get a mapping between brokers and adapters.", + "description": "Get a mapping between brokers and adapters.", + "tags": ["adapters"], + "parameters": [], + "operationId": "Adapters.getBrokerMap", + "responses": { + "200": { + "description": "Mapping between brokers and adapters in IAP.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": [ + { + "aaa": ["Local AAA"] + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Adapters.admin", "Adapters.apiread"], + "CookieAuth": ["Adapters.admin", "Adapters.apiread"], + "BasicAuth": ["Adapters.admin", "Adapters.apiread"] + } + ], + "deprecated": false + } + }, + "/whoami": { + "get": { + "summary": "Gets the authorization data for the logged in user", + "description": "Gets the authorization data for the logged in user", + "tags": ["authentication"], + "parameters": [ + { + "name": "roles", + "in": "query", + "description": "roles", + "required": false, + "schema": { + "type": "string", + "enum": ["names", "ids"] + } + } + ], + "operationId": "Authentication.whoAmI", + "responses": { + "200": { + "description": "Authorization data for a user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "type": "string", + "description": "The name of the AAA adapter from which the user logged in", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "description": "The username of the logged in user", + "examples": ["jane_doe"] + }, + "firstname": { + "type": "string", + "description": "The first name of the logged in user", + "examples": ["Jane"] + }, + "groups": { + "type": "array", + "description": "An array of groups which contain the logged in user", + "items": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "type": "string", + "description": "The name of the AAA adapter which contains the group", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "description": "The name of the group", + "examples": ["admin_group"] + } + } + } + }, + "roles": { + "type": "array", + "description": "Array of roles user has access to", + "items": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + }, + "roleNames": { + "type": "array", + "description": "Array of role names that user has access to", + "items": { + "type": "string" + } + }, + "routes": { + "type": "array", + "description": "Array of routes logged in user has access to", + "items": { + "type": "string", + "examples": ["/admin/"] + } + }, + "methods": { + "type": "object", + "description": "Map of service names and method names which the user has access to", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The name of a method within an application", + "examples": ["getProfiles"] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/mySession": { + "get": { + "summary": "Gets the session document for the active user", + "description": "Gets the session for the active user", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getMySession", + "responses": { + "200": { + "description": "The session document for the logged in user.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The session token for the logged in user" + }, + "loginMethod": { + "type": "string", + "description": "The way a user logged in", + "enum": ["Web", "sudo"] + }, + "session_start": { + "type": "integer", + "description": "The Unix epoch time when the session started" + }, + "ttl": { + "type": "integer", + "description": "The default ttl for a user session" + }, + "principalId": { + "type": "string", + "description": "The accountId for the logged in user" + }, + "requestCount": { + "type": "integer", + "description": "The number of API requests made during the active session" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/myPrincipal": { + "get": { + "summary": "Gets the principal document for the active user", + "description": "Gets the principal for the active user", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getMyPrincipal", + "responses": { + "200": { + "description": "The principal document for the logged in user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "type": "string", + "description": "The name of the AAA adapter from which the user logged in", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "description": "The username of the logged in user", + "examples": ["jane_doe"] + }, + "firstname": { + "type": "string", + "description": "The first name of the logged in user", + "examples": ["Jane"] + }, + "groups": { + "type": "array", + "description": "An array of groups which contain the logged in user", + "items": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "type": "string", + "description": "The name of the AAA adapter which contains the group", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "description": "The name of the group", + "examples": ["admin_group"] + } + } + } + }, + "roles": { + "type": "array", + "description": "Array of roles user has access to", + "items": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + }, + "roleNames": { + "type": "array", + "description": "Array of role names user has access to", + "items": { + "type": "string" + } + }, + "allowedMethods": { + "type": "array", + "description": "The API methods which a user has access to", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "description": "The service which contains the method", + "examples": ["AutomationStudio"] + }, + "name": { + "type": "string", + "description": "The name of the method", + "examples": ["getTemplates"] + } + } + } + }, + "allowedViews": { + "type": "array", + "description": "The URL pages which a user has access to", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "description": "The service which contains the view", + "examples": ["AutomationStudio"] + }, + "path": { + "type": "string", + "description": "The URL route to the view", + "examples": ["/automation-studio/"] + } + } + } + }, + "routes": { + "type": "array", + "description": "Array of routes logged in user has access to", + "items": { + "type": "string", + "examples": ["/admin/"] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/myTtl": { + "get": { + "summary": "Get the number of seconds until the logged in user's session expires.", + "description": "Get the number of seconds until the user is logged out.", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getMyTtl", + "responses": { + "200": { + "description": "The number of seconds until the logged in user's session expires", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "integer" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/sso": { + "get": { + "summary": "Log in and create a session in IAP using single sign on", + "description": "Log into IAP using single sign on", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.sso", + "responses": { + "200": { + "description": "No output.", + "content": { + "application/json": { + "schema": {} + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/sso/test/{name}": { + "get": { + "summary": "Test logging into IAP using a saved single sign on configuration", + "description": "Test logging into IAP using single sign on", + "tags": ["authentication"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "Authentication.ssoTest", + "responses": { + "200": { + "description": "No output.", + "content": { + "application/json": { + "schema": {} + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/saml/callback": { + "post": { + "summary": "This the route used by the SAML identity provider to callback to IAP with the authentication response. This is not meant for manual use.", + "description": "Callback used by the SAML identity provider", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.samlCallback", + "responses": { + "200": { + "description": "No output.", + "content": { + "application/json": { + "schema": {} + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/sso/enabled": { + "get": { + "summary": "Get whether or not single sign on is enabled", + "description": "Get whether or not single sign on is enabled", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.isSSOEnabled", + "responses": { + "200": { + "description": "Whether or not single sign on is enabled", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/login": { + "post": { + "summary": "Log in an create a session in IAP", + "description": "Log in to IAP", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.login", + "responses": { + "200": { + "description": "The session token for a logged in user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string", + "examples": ["MTQ4ZmMzMGMxOTQ2MTg4N2ZjMDhiMTY0MzlkYTgwZmM="] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false, + "requestBody": { + "description": "credentials", + "content": { + "application/json": { + "schema": { + "title": "credentials", + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/logout": { + "get": { + "summary": "Log out of IAP and delete current session", + "description": "Log out of IAP", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.logout", + "responses": { + "200": { + "description": "The return data from logging out", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string", + "examples": ["You have successfully logged out."] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/download": { + "get": { + "summary": "Download a public file from IAP", + "description": "Download a public file from IAP", + "tags": ["authentication"], + "parameters": [ + { + "name": "file_name", + "in": "query", + "description": "file_name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "operationId": "Authentication.download", + "responses": { + "200": { + "description": "The contents of the file downloaded", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string", + "examples": ["this is the contents of a file"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/system/id": { + "get": { + "summary": "Get system server id.", + "description": "Get system server id for the current IAP.", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getSystemId", + "responses": { + "200": { + "description": "serverId of the current IAP.", + "content": { + "application/json": { + "schema": { + "title": "serverId", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/version": { + "get": { + "summary": "Get verion.", + "description": "Get release verion of current IAP.", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getReleaseVersion", + "responses": { + "200": { + "description": "Release Version of the current IAP.", + "content": { + "application/json": { + "schema": { + "title": "releaseVersion", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/config/apps": { + "get": { + "summary": "Get all application configs in IAP.", + "description": "Get all application configs in IAP.", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.getApplicationConfigs", + "responses": { + "200": { + "description": "Contains the configuration of all applications.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "title": "id", + "type": "string" + }, + "export": { + "title": "export", + "type": "string" + }, + "title": { + "title": "title", + "type": "string" + }, + "type": { + "title": "type", + "type": "string" + }, + "summary": { + "title": "summary", + "type": "string" + }, + "pdb": { + "title": "pdb", + "type": "boolean" + }, + "roles": { + "title": "roles", + "type": "array", + "items": { + "type": "string" + } + }, + "methods": { + "title": "methods", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "description": { + "title": "description", + "type": "string" + }, + "summary": { + "title": "summary", + "type": "string" + }, + "deprecated": { + "title": "deprecated", + "type": "boolean" + }, + "roles": { + "title": "roles", + "type": "array", + "items": { + "type": "string" + } + }, + "route": { + "title": "route", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string" + }, + "verb": { + "title": "verb", + "type": "string" + } + } + }, + "input": { + "title": "input", + "type": "array", + "items": { + "type": "object" + } + }, + "output": { + "title": "output", + "type": "object" + } + } + } + }, + "views": { + "title": "views", + "type": "array", + "items": { + "type": "object" + } + }, + "src": { + "title": "src", + "type": "string" + }, + "encrypted": { + "title": "encrypted", + "type": "boolean" + }, + "version": { + "title": "version", + "type": "string" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/profile/{username}": { + "get": { + "summary": "Gets the user profile for the active user", + "description": "Gets the user profile for the active user", + "tags": ["authentication"], + "parameters": [ + { + "name": "username", + "in": "path", + "description": "The exact username for the logged in user", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema_username" + } + } + ], + "operationId": "Authentication.getUserProfile", + "responses": { + "200": { + "description": "The account document for the logged in user.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": true + } + }, + "/profile/update": { + "put": { + "summary": "Updates the user profile for the active user", + "description": "Updates the user profile for the active user", + "tags": ["authentication"], + "parameters": [], + "operationId": "Authentication.updateUserProfile", + "responses": { + "200": { + "description": "Updated account document for current user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": true, + "requestBody": { + "description": "userProfile", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "username": { + "$ref": "#/components/schemas/iap_accounts-schema_username" + }, + "email": { + "$ref": "#/components/schemas/iap_accounts-schema_email" + } + }, + "required": ["username"], + "additionalProperties": false + } + } + } + } + } + }, + "/adapter-models/types": { + "get": { + "summary": "Get the list of available adapter model types.", + "description": "Get the list of available adapter model types in the current IAP.", + "tags": ["adapter-models"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["profile1"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["profile1"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["profile"] + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "AdapterModels.getAdapterModelTypes", + "responses": { + "200": { + "description": "Contains an array of adapter model types and the total.", + "content": { + "application/json": { + "schema": { + "title": "adapterModels", + "type": "object", + "required": ["adapterModels", "total"], + "properties": { + "adapterModels": { + "type": "array", + "items": { + "type": "string", + "examples": ["local_aaa", "redis"] + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AdapterModels.admin", "AdapterModels.apiread"], + "CookieAuth": ["AdapterModels.admin", "AdapterModels.apiread"], + "BasicAuth": ["AdapterModels.admin", "AdapterModels.apiread"] + } + ], + "deprecated": false + } + }, + "/integration-models": { + "post": { + "summary": "Create a new integration model.", + "description": "Create a new integration model in IAP.", + "tags": ["integration-models"], + "parameters": [], + "operationId": "IntegrationModels.createIntegrationModel", + "responses": { + "200": { + "description": "The output of the integration model creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "type": "object", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "model": { + "title": "model", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + } + }, + "get": { + "summary": "Get all integration models.", + "description": "Get all the integration models in IAP.", + "tags": ["integration-models"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "Filter the response based on each item that includes the provided query.", + "required": false, + "schema": { + "type": "string", + "description": "Filter the response based on each item that includes the provided query.", + "examples": ["git", "hub", "v5"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "enum": ["versionId"] + } + }, + { + "name": "equals", + "in": "query", + "description": "Filter the response based on each item that is an exact match to the provided query.", + "required": false, + "schema": { + "type": "string", + "description": "Filter the response based on each item that is an exact match to the provided query.", + "examples": ["GitHub:v5"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "enum": ["versionId"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "Filter the response based on each item that starts with the provided query.", + "required": false, + "schema": { + "type": "string", + "description": "Filter the response based on each item that starts with the provided query.", + "examples": ["g"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "enum": ["versionId"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by. Default is versionId.", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by. Default is versionId.", + "enum": ["versionId"] + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "IntegrationModels.getIntegrationModels", + "responses": { + "200": { + "description": "Contains the data for all integration models.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "integrationModels": { + "type": "object", + "properties": { + "model": { + "type": "string", + "examples": ["@itential/adapter_GitHub:v5"] + }, + "versionId": { + "type": "string", + "examples": ["GitHub:v5"] + }, + "description": { + "type": "string", + "examples": [ + "A standard description about the integration model" + ] + }, + "properties": { + "type": "object", + "description": "Refer to OpenAPI specifications for the available properties for this OpenAPI document." + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ], + "CookieAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ], + "BasicAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an integration model.", + "description": "Update an integration model in IAP.", + "tags": ["integration-models"], + "parameters": [], + "operationId": "IntegrationModels.updateIntegrationModel", + "responses": { + "200": { + "description": "The output of the update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "type": "object", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "model": { + "title": "model", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + } + } + }, + "/integration-models/{name}": { + "delete": { + "summary": "Delete an integration model.", + "description": "Delete an integration model from IAP.", + "tags": ["integration-models"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the integration model.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["GitHub:v5"] + } + } + ], + "operationId": "IntegrationModels.deleteIntegrationModel", + "responses": { + "200": { + "description": "The output of the integration model deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a specific integration model.", + "description": "Get a specific integration model in IAP.", + "tags": ["integration-models"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the integration model.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["Gitlab:v5"] + } + } + ], + "operationId": "IntegrationModels.getIntegrationModel", + "responses": { + "200": { + "description": "Contains the data for a specific integration model.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "model": { + "type": "string", + "examples": ["@itential/adapter_GitHub:v5"] + }, + "versionId": { + "type": "string", + "examples": ["GitHub:v5"] + }, + "description": { + "type": "string", + "examples": [ + "A standard description about the integration model" + ] + }, + "properties": { + "type": "object", + "description": "Refer to OpenAPI specifications for the available properties for this OpenAPI document." + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ], + "CookieAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ], + "BasicAuth": [ + "IntegrationModels.admin", + "IntegrationModels.apiread" + ] + } + ], + "deprecated": false + } + }, + "/integration-models/{name}/export": { + "get": { + "summary": "Export an integration model.", + "description": "Export an integration model's open API spec.", + "tags": ["integration-models"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the integration model.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["GitHub:v5"] + } + } + ], + "operationId": "IntegrationModels.exportIntegrationModel", + "responses": { + "200": { + "description": "The integration model open api spec.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document.", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false + } + }, + "/integration-models/{name}/securitySchemes": { + "get": { + "summary": "Gets an integration model's security schemes.", + "description": "Projection simplification for exportIntegrationModel", + "tags": ["integration-models"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the integration model.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["GitHub:v5"] + } + } + ], + "operationId": "IntegrationModels.getIntegrationModelSecuritySchemes", + "responses": { + "200": { + "description": "The integration model's security schemes according to its open api spec.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "description": "Refer to OpenAPI specifications for the structure of the security schemes of an OpenAPI document.", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false + } + }, + "/integration-models/validation": { + "put": { + "summary": "Validate an integration model.", + "description": "Validate an integration model.", + "tags": ["integration-models"], + "parameters": [], + "operationId": "IntegrationModels.validateIntegrationModel", + "responses": { + "200": { + "description": "The output of the integration model validation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "description": "Message containing either confirmation that the OpenAPI document is valid or validation errors related to the OpenAPI document.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["IntegrationModels.admin"], + "CookieAuth": ["IntegrationModels.admin"], + "BasicAuth": ["IntegrationModels.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "model": { + "title": "model", + "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." + } + } + } + } + } + } + } + }, + "/integrations": { + "post": { + "summary": "Create a new integration.", + "description": "Create a new integration in IAP.", + "tags": ["integrations"], + "parameters": [], + "operationId": "Integrations.createIntegration", + "responses": { + "200": { + "description": "The result of the integration creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "model": { + "$ref": "#/components/schemas/iap_services-schema_model" + }, + "name": { + "$ref": "#/components/schemas/iap_services-schema_name" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "$ref": "#/components/schemas/iap_services-schema_properties" + }, + "virtual": { + "$ref": "#/components/schemas/iap_services-schema_virtual" + } + }, + "required": ["name", "type", "properties", "virtual"] + } + } + } + } + } + } + }, + "get": { + "summary": "Get all integrations.", + "description": "Get all integrations in IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["GitHub"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["GitHub"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["GitHub"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "skipActiveSync", + "in": "query", + "description": "skipActiveSync", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + } + ], + "operationId": "Integrations.getIntegrations", + "responses": { + "200": { + "description": "Contains an array of integrations and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Integrations.admin", "Integrations.apiread"], + "CookieAuth": ["Integrations.admin", "Integrations.apiread"], + "BasicAuth": ["Integrations.admin", "Integrations.apiread"] + } + ], + "deprecated": false + } + }, + "/integrations/{name}": { + "delete": { + "summary": "Delete an integration.", + "description": "Delete an integration from IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.deleteIntegration", + "responses": { + "200": { + "description": "The output of the integration deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a single integration.", + "description": "Get a single integration in IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.getIntegration", + "responses": { + "200": { + "description": "Contains the data of a single integration.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Integrations.admin", "Integrations.apiread"], + "CookieAuth": ["Integrations.admin", "Integrations.apiread"], + "BasicAuth": ["Integrations.admin", "Integrations.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an integration.", + "description": "Update an integration in IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Contains the name for the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.updateIntegration", + "responses": { + "200": { + "description": "The output of the integration update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "$ref": "#/components/schemas/iap_services-schema_properties" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/integrations/{name}/authCode": { + "post": { + "summary": "Posts an access token with an Authorization Code", + "description": "Initiates the Authorization Code exchange for an access token and stores the change", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.postAuthFlowAccessToken", + "responses": { + "200": { + "description": "The success of the operation", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "description": "Some description", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorizationCode": { + "title": "authorizationCode", + "type": "string" + }, + "redirectUri": { + "title": "redirectUri", + "type": "string" + } + } + } + } + } + } + } + }, + "/integrations/{name}/properties": { + "put": { + "summary": "Update the properties of an integration.", + "description": "Update the properties of an integration in IAP.", + "tags": ["integrations"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected integration.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Integrations.updateIntegrationProperties", + "responses": { + "200": { + "description": "The output of the integration properties update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Integrations.admin"], + "CookieAuth": ["Integrations.admin"], + "BasicAuth": ["Integrations.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties" + } + } + } + } + } + } + } + }, + "/server/config": { + "get": { + "summary": "Get the full IAP configuration.", + "description": "Returns the full IAP configuration, with value/origin definitions for each property.", + "tags": ["server"], + "parameters": [], + "operationId": "Server.getConfig", + "responses": { + "200": { + "description": "The full IAP configuration.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "array", + "items": { + "type": "object", + "required": ["name", "value", "origin"], + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": [ + "null", + "string", + "boolean", + "number", + "object", + "array" + ] + }, + "origin": { + "type": "string" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Server.admin", "Server.apiread"], + "CookieAuth": ["Server.admin", "Server.apiread"], + "BasicAuth": ["Server.admin", "Server.apiread"] + } + ], + "deprecated": false + } + }, + "/server/config/{key}": { + "get": { + "summary": "Get a single IAP configuration property.", + "description": "Returns a single IAP configuration property, with value/origin definitions.", + "tags": ["server"], + "parameters": [ + { + "name": "key", + "in": "path", + "description": "The configuration property key.", + "required": true, + "schema": {} + } + ], + "operationId": "Server.getConfigProperty", + "responses": { + "200": { + "description": "The value and origin of the requested property.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "required": ["name", "value", "origin"], + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": [ + "null", + "string", + "boolean", + "number", + "object", + "array" + ] + }, + "origin": { + "type": "string" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Server.admin", "Server.apiread"], + "CookieAuth": ["Server.admin", "Server.apiread"], + "BasicAuth": ["Server.admin", "Server.apiread"] + } + ], + "deprecated": false + } + }, + "/applications/{name}": { + "get": { + "summary": "Get a single application.", + "description": "Get a single application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.getApplication", + "responses": { + "200": { + "description": "Contains the data of a single application.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + }, + "required": ["isActive"] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Applications.admin", "Applications.apiread"], + "CookieAuth": ["Applications.admin", "Applications.apiread"], + "BasicAuth": ["Applications.admin", "Applications.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an application.", + "description": "Update an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.updateApplication", + "responses": { + "200": { + "description": "The output of the application update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "loggerProps": { + "$ref": "#/components/schemas/iap_services-schema_loggerProps" + }, + "isEncrypted": { + "$ref": "#/components/schemas/iap_services-schema_isEncrypted" + }, + "type": { + "$ref": "#/components/schemas/iap_services-schema_type" + }, + "properties": { + "$ref": "#/components/schemas/iap_services-schema_properties" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/applications/{name}/changelogs": { + "get": { + "summary": "Get the list of changelogs.", + "description": "Get the list of changelogs for a specific application.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + }, + { + "name": "release", + "in": "query", + "description": "release", + "required": false, + "schema": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + } + } + ], + "operationId": "Applications.getApplicationChangelogs", + "responses": { + "200": { + "description": "The list of changelogs available for the requested application.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "string", + "examples": [ + { + "2020.1.1": "Changelog for 2020.1" + } + ], + "pattern": "^[0-9]{4}[.][0-9]{1,}[.][0-9]{1,}$" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Applications.admin", "Applications.apiread"], + "CookieAuth": ["Applications.admin", "Applications.apiread"], + "BasicAuth": ["Applications.admin", "Applications.apiread"] + } + ], + "deprecated": true + } + }, + "/applications": { + "get": { + "summary": "Get all applications.", + "description": "Get all applications in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Applications.getApplications", + "responses": { + "200": { + "description": "Contains an array of applications and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "oneOf": [ + { + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + } + }, + { + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + } + } + } + ] + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Applications.admin", "Applications.apiread"], + "CookieAuth": ["Applications.admin", "Applications.apiread"], + "BasicAuth": ["Applications.admin", "Applications.apiread"] + } + ], + "deprecated": false + } + }, + "/applications/{name}/start": { + "put": { + "summary": "Start an application.", + "description": "Start an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.startApplication", + "responses": { + "200": { + "description": "The result of the start process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false + } + }, + "/applications/{name}/stop": { + "put": { + "summary": "Stop an application.", + "description": "Stop an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.stopApplication", + "responses": { + "200": { + "description": "The result of the stop process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false + } + }, + "/applications/{name}/restart": { + "put": { + "summary": "Restart an application.", + "description": "Restart an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.restartApplication", + "responses": { + "200": { + "description": "The result of the restart process contains the status of the command.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false + } + }, + "/applications/{name}/loglevel": { + "put": { + "summary": "Update the log levels.", + "description": "Update the log levels for an application.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.updateApplicationLogging", + "responses": { + "200": { + "description": "The result of updating the log levels for an application.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "transport": { + "type": "string", + "enum": ["file", "console", "syslog"] + } + }, + "if": { + "properties": { + "transport": { + "const": "syslog" + } + } + }, + "then": { + "properties": { + "level": { + "$ref": "#/components/schemas/iap_services-schema_sys_log_level" + } + } + }, + "else": { + "properties": { + "level": { + "$ref": "#/components/schemas/iap_services-schema_log_level" + } + } + } + } + } + } + } + } + } + } + }, + "/applications/{name}/properties": { + "put": { + "summary": "Update the properties of an application.", + "description": "Update the properties of an application in IAP.", + "tags": ["applications"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Applications.updateApplicationProperties", + "responses": { + "200": { + "description": "The output of the application properties update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_services-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Applications.admin"], + "CookieAuth": ["Applications.admin"], + "BasicAuth": ["Applications.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties" + } + } + } + } + } + } + } + }, + "/user/settings": { + "get": { + "summary": "Gets the user settings for the active user", + "description": "Gets the user settings for the active user", + "tags": ["user"], + "parameters": [], + "operationId": "UserSettings.getUserSettings", + "responses": { + "200": { + "description": "The account document for the logged in user.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Updates the user settings for the active user", + "description": "Updates the user settings for the active user", + "tags": ["user"], + "parameters": [], + "operationId": "UserSettings.updateUserSettings", + "responses": { + "200": { + "description": "Updated account document for current user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "type": "object", + "properties": { + "gitTokens": { + "$ref": "#/components/schemas/iap_accounts-schema_gitTokens" + }, + "email": { + "$ref": "#/components/schemas/iap_accounts-schema_email" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/schema/adapters/{name}": { + "get": { + "summary": "Get the adapter schema.", + "description": "Get the adapter schema.", + "tags": ["schema"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["redis", "email"] + } + } + ], + "operationId": "Schema.getAdapterSchema", + "responses": { + "200": { + "description": "Contains the schema for an adapter.", + "content": { + "application/json": { + "schema": { + "title": "schema", + "type": "object", + "properties": { + "schema": { + "$ref": "#/components/schemas/iap_services-schema" + }, + "decorators": { + "$ref": "#/components/schemas/iap_decorators-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Schema.admin", "Schema.apiread"], + "CookieAuth": ["Schema.admin", "Schema.apiread"], + "BasicAuth": ["Schema.admin", "Schema.apiread"] + } + ], + "deprecated": false + } + }, + "/schema/applications/{name}": { + "get": { + "summary": "Get the application schema.", + "description": "Get the application schema.", + "tags": ["schema"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["redis", "email"] + } + } + ], + "operationId": "Schema.getApplicationSchema", + "responses": { + "200": { + "description": "Contains the schema for an application.", + "content": { + "application/json": { + "schema": { + "title": "schema", + "type": "object", + "properties": { + "schema": { + "$ref": "#/components/schemas/iap_services-schema" + }, + "decorators": { + "$ref": "#/components/schemas/iap_decorators-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Schema.admin", "Schema.apiread"], + "CookieAuth": ["Schema.admin", "Schema.apiread"], + "BasicAuth": ["Schema.admin", "Schema.apiread"] + } + ], + "deprecated": false + } + }, + "/schema/integrations/{name}": { + "get": { + "summary": "Get the integration schema.", + "description": "Get the integration schema.", + "tags": ["schema"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected integration.", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["ghv5", "ghv6"] + } + } + ], + "operationId": "Schema.getIntegrationSchema", + "responses": { + "200": { + "description": "Contains the schema for an integration.", + "content": { + "application/json": { + "schema": { + "title": "schema", + "type": "object", + "properties": { + "schema": { + "$ref": "#/components/schemas/iap_services-schema" + }, + "decorators": { + "$ref": "#/components/schemas/iap_decorators-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Schema.admin", "Schema.apiread"], + "CookieAuth": ["Schema.admin", "Schema.apiread"], + "BasicAuth": ["Schema.admin", "Schema.apiread"] + } + ], + "deprecated": false + } + }, + "/schema/profiles": { + "get": { + "summary": "Get the profile schema.", + "description": "Get the profile schema.", + "tags": ["schema"], + "parameters": [], + "operationId": "Schema.getProfileSchema", + "responses": { + "200": { + "description": "Contains the schema for profiles.", + "content": { + "application/json": { + "schema": { + "title": "schema", + "type": "object", + "properties": { + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema" + }, + "decorators": { + "$ref": "#/components/schemas/iap_decorators-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Schema.admin", "Schema.apiread"], + "CookieAuth": ["Schema.admin", "Schema.apiread"], + "BasicAuth": ["Schema.admin", "Schema.apiread"] + } + ], + "deprecated": false + } + }, + "/customization/banner": { + "get": { + "summary": "Get banner.", + "description": "Get banner for customization", + "tags": ["customization"], + "parameters": [], + "operationId": "Customization.getBanner", + "responses": { + "200": { + "description": "The banner object from the database", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/iap_banner-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update the banner.", + "description": "Update the banner", + "tags": ["customization"], + "parameters": [], + "operationId": "Customization.updateBanner", + "responses": { + "200": { + "description": "The result from the database", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Customization.admin"], + "CookieAuth": ["Customization.admin"], + "BasicAuth": ["Customization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_banner-schema" + } + } + } + } + } + }, + "/help/adapters/html": { + "get": { + "summary": "Generate documentation for adapters", + "description": "Generate an HTML documentation page for adapters", + "tags": ["help"], + "parameters": [], + "operationId": "Help.getAdaptersHtml", + "responses": { + "200": { + "description": "HTML string containing documentation for adapter functions.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/help/brokers/html": { + "get": { + "summary": "Generate documentation for brokers", + "description": "Generate an HTML documentation page for brokers", + "tags": ["help"], + "parameters": [], + "operationId": "Help.getBrokersHtml", + "responses": { + "200": { + "description": "HTML string containing documentation for broker functions.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/help/applications/html": { + "get": { + "summary": "Generate documentation for applications", + "description": "Generate an HTML documentation page for applications", + "tags": ["help"], + "parameters": [], + "operationId": "Help.getApplicationsHtml", + "responses": { + "200": { + "description": "HTML string containing documentation for application functions.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/help/openapi": { + "get": { + "summary": "Generate an OpenAPI v3 document for IAP", + "description": "Generate an OpenAPI v3.1.0 document for IAP", + "tags": ["help"], + "parameters": [ + { + "name": "url", + "in": "query", + "description": "url", + "required": false, + "schema": { + "type": "string", + "examples": ["http://localhost:3000"] + } + } + ], + "operationId": "Help.getOpenApi", + "responses": { + "200": { + "description": "An OpenAPI v3 document containing all IAP routes", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/indexes": { + "get": { + "summary": "Get all pre-defined indexes.", + "description": "Get all pre-defined indexes to be used in Mongo.", + "tags": ["indexes"], + "parameters": [ + { + "name": "application", + "in": "query", + "description": "application", + "required": false, + "schema": { + "type": "string", + "examples": ["@itential/app-workflow_engine"] + } + } + ], + "operationId": "Indexes.getIndexes", + "responses": { + "200": { + "description": "Contains an array of pre-defined Mongo indexes.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Indexes.admin", "Indexes.apiread"], + "CookieAuth": ["Indexes.admin", "Indexes.apiread"], + "BasicAuth": ["Indexes.admin", "Indexes.apiread"] + } + ], + "deprecated": false + } + }, + "/indexes/{collection}/status": { + "get": { + "summary": "Check the status of a collection's indexes in Mongo", + "description": "Check the status of pre-defined indexes for a specific collection.", + "tags": ["indexes"], + "parameters": [ + { + "name": "collection", + "in": "path", + "description": "The name of a collection in Mongo.", + "required": true, + "schema": { + "type": "string", + "title": "collection", + "description": "The collection name in the database." + } + } + ], + "operationId": "Indexes.checkIndexes", + "responses": { + "200": { + "description": "The current statuses of the indexes on the specified collection.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "missing": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "misnamed": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "external": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "indexed": { + "type": "integer", + "minimum": 0 + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + }, + "collectionSize": { + "type": "integer" + }, + "inProgress": { + "type": "boolean" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Indexes.admin", "Indexes.apiread"], + "CookieAuth": ["Indexes.admin", "Indexes.apiread"], + "BasicAuth": ["Indexes.admin", "Indexes.apiread"] + } + ], + "deprecated": false + } + }, + "/indexes/status": { + "get": { + "summary": "Check the status of multiple collections' indexes in Mongo", + "description": "Check the status of pre-defined indexes for multiple collections.", + "tags": ["indexes"], + "parameters": [ + { + "name": "collections", + "in": "query", + "description": "collections", + "required": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["accounts", "automations"]] + }, + { + "type": "string", + "examples": ["accounts"] + } + ] + } + } + ], + "operationId": "Indexes.checkMultipleIndexes", + "responses": { + "200": { + "description": "The current statuses of the indexes on the specified collections.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": {}, + "additionalProperties": { + "title": "result", + "type": "object", + "properties": { + "missing": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "misnamed": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_indexes-schema" + } + }, + "indexed": { + "type": "integer", + "minimum": 0 + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + }, + "collectionSize": { + "type": "integer" + }, + "inProgress": { + "type": "boolean" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Indexes.admin", "Indexes.apiread"], + "CookieAuth": ["Indexes.admin", "Indexes.apiread"], + "BasicAuth": ["Indexes.admin", "Indexes.apiread"] + } + ], + "deprecated": false + } + }, + "/indexes/{collection}": { + "post": { + "summary": "Create a collection's indexes in Mongo", + "description": "Create all pre-defined indexes for a specific collection.", + "tags": ["indexes"], + "parameters": [ + { + "name": "collection", + "in": "path", + "description": "The name of a collection in Mongo.", + "required": true, + "schema": { + "type": "string", + "title": "collection", + "description": "The collection name in the database." + } + } + ], + "operationId": "Indexes.createIndexes", + "responses": { + "200": { + "description": "The current status of the index creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "unchanged": { + "type": "integer", + "minimum": 0 + }, + "changed": { + "type": "integer", + "minimum": 0 + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + }, + "running": { + "type": "boolean" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Indexes.admin"], + "CookieAuth": ["Indexes.admin"], + "BasicAuth": ["Indexes.admin"] + } + ], + "deprecated": false + } + }, + "/authorization/accounts": { + "get": { + "summary": "Get all accounts.", + "description": "Get all accounts", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_accounts-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_accounts-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_accounts-query" + } + }, + { + "name": "inactive", + "in": "query", + "description": "inactive", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema_inactive" + } + }, + { + "name": "isServiceAccount", + "in": "query", + "description": "isServiceAccount", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema_isServiceAccount" + } + }, + { + "name": "groupId", + "in": "query", + "description": "groupId", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "loggedIn", + "in": "query", + "description": "loggedIn", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema_loggedIn" + } + } + ], + "operationId": "Authorization.getAccounts", + "responses": { + "200": { + "description": "The accounts matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_accounts-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + } + }, + "/authorization/accounts/{accountId}": { + "get": { + "summary": "Get an individual account.", + "description": "Get an individual account", + "tags": ["authorization"], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The id for the requested account.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.getAccount", + "responses": { + "200": { + "description": "The individual account document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update an account.", + "description": "Update an account", + "tags": ["authorization"], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The individual account to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.updateAccount", + "responses": { + "200": { + "description": "The output of the account update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_accounts-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "inactive": { + "$ref": "#/components/schemas/iap_accounts-schema_inactive" + }, + "email": { + "$ref": "#/components/schemas/iap_accounts-schema_email" + }, + "assignedRoles": { + "$ref": "#/components/schemas/iap_accounts-schema_assignedRoles" + }, + "memberOf": { + "$ref": "#/components/schemas/iap_accounts-schema_memberOf" + } + } + } + } + } + } + } + } + } + }, + "/authorization/accounts/{accountId}/forceLogout": { + "post": { + "summary": "Force a user to logout and remove their session.", + "description": "Force a user to logout", + "tags": ["authorization"], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The individual account to logout.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.forceLogout", + "responses": { + "200": { + "description": "The output of removing a session", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false + } + }, + "/authorization/groups": { + "get": { + "summary": "Get a list of groups.", + "description": "Get a list of groups", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "inactive", + "in": "query", + "description": "inactive", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_groups-schema_inactive" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "refresh", + "in": "query", + "description": "whether to refresh groups from AAA", + "required": false, + "schema": { + "type": "boolean", + "title": "refresh", + "description": "whether to refresh groups from AAA", + "default": false + } + } + ], + "operationId": "Authorization.getGroups", + "responses": { + "200": { + "description": "The groups matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_groups-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Create a group.", + "description": "Create a group", + "tags": ["authorization"], + "parameters": [], + "operationId": "Authorization.createGroup", + "responses": { + "200": { + "description": "Result of group creation process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_groups-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "$ref": "#/components/schemas/iap_groups-schema" + } + } + } + } + } + } + } + }, + "/authorization/groups/list": { + "get": { + "summary": "Get a simplified list of groups.", + "description": "Get a simplified list of groups", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_groups-query" + } + }, + { + "name": "inactive", + "in": "query", + "description": "inactive", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_groups-schema_inactive" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "refresh", + "in": "query", + "description": "whether to refresh groups from AAA", + "required": false, + "schema": { + "type": "boolean", + "title": "refresh", + "description": "whether to refresh groups from AAA", + "default": false + } + } + ], + "operationId": "Authorization.getGroupsShortList", + "responses": { + "200": { + "description": "The groups matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + }, + "provenance": { + "$ref": "#/components/schemas/iap_groups-schema_provenance" + }, + "name": { + "$ref": "#/components/schemas/iap_groups-schema_name" + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/authorization/groups/{groupId}": { + "get": { + "summary": "Get an individual group.", + "description": "Get an individual group", + "tags": ["authorization"], + "parameters": [ + { + "name": "groupId", + "in": "path", + "description": "The id for the requested group.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.getGroup", + "responses": { + "200": { + "description": "The individual group document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_groups-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update a group.", + "description": "Update a group", + "tags": ["authorization"], + "parameters": [ + { + "name": "groupId", + "in": "path", + "description": "The individual group to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.updateGroup", + "responses": { + "200": { + "description": "The output of the group update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_groups-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/iap_groups-schema_description" + }, + "inactive": { + "$ref": "#/components/schemas/iap_groups-schema_inactive" + }, + "memberOf": { + "$ref": "#/components/schemas/iap_groups-schema_memberOf" + }, + "assignedRoles": { + "$ref": "#/components/schemas/iap_groups-schema_assignedRoles" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a group.", + "description": "Delete a group", + "tags": ["authorization"], + "parameters": [ + { + "name": "groupId", + "in": "path", + "description": "The individual group to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Authorization.deleteGroup", + "responses": { + "200": { + "description": "Result of group deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false + } + }, + "/authorization/roles": { + "get": { + "summary": "Get a list of roles.", + "description": "Get a list of roles", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roles-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roles-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roles-query" + } + }, + { + "name": "inactive", + "in": "query", + "description": "inactive", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Authorization.getRoles", + "responses": { + "200": { + "description": "The roles matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_roles-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Create a role.", + "description": "Create a role", + "tags": ["authorization"], + "parameters": [], + "operationId": "Authorization.createRole", + "responses": { + "200": { + "description": "Result of role creation process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_roles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "$ref": "#/components/schemas/iap_roles-schema" + } + } + } + } + } + } + } + }, + "/authorization/roles/{roleId}": { + "get": { + "summary": "Get an individual role.", + "description": "Get an individual role", + "tags": ["authorization"], + "parameters": [ + { + "name": "roleId", + "in": "path", + "description": "The id for the requested role.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roleId" + } + } + ], + "operationId": "Authorization.getRole", + "responses": { + "200": { + "description": "The individual role document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_roles-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update a role.", + "description": "Update a role", + "tags": ["authorization"], + "parameters": [ + { + "name": "roleId", + "in": "path", + "description": "The individual role to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roleId" + } + } + ], + "operationId": "Authorization.updateRole", + "responses": { + "200": { + "description": "The output of the role update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_roles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/iap_roles-schema_description" + }, + "allowedMethods": { + "$ref": "#/components/schemas/iap_roles-schema_allowedMethods" + }, + "allowedViews": { + "$ref": "#/components/schemas/iap_roles-schema_allowedViews" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a role.", + "description": "Delete a role", + "tags": ["authorization"], + "parameters": [ + { + "name": "roleId", + "in": "path", + "description": "The individual role to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_authorization-common_roleId" + } + } + ], + "operationId": "Authorization.deleteRole", + "responses": { + "200": { + "description": "Result of role deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin"], + "CookieAuth": ["Authorization.admin"], + "BasicAuth": ["Authorization.admin"] + } + ], + "deprecated": false + } + }, + "/authorization/methods": { + "get": { + "summary": "Get a list of methods.", + "description": "Get a list of methods in IAP.", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_methods-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_methods-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_methods-query" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Authorization.getMethods", + "responses": { + "200": { + "description": "List of methods in IAP.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["getRoles"] + }, + "provenance": { + "type": "string", + "examples": ["Authorization"] + }, + "route": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/roles"] + }, + "verb": { + "type": "string", + "examples": ["GET"] + }, + "fullPath": { + "type": "string", + "examples": ["/authorization/roles"] + } + } + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + } + }, + "/authorization/views": { + "get": { + "summary": "Get a list of views.", + "description": "Get a list of views in IAP.", + "tags": ["authorization"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_views-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_views-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_system-common_views-query" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Authorization.getViews", + "responses": { + "200": { + "description": "List of views in IAP.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/"] + }, + "provenance": { + "type": "string", + "examples": ["WorkFlowEngine"] + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + } + }, + "/authorization/csv/export": { + "get": { + "summary": "Extract CSV data of accounts, groups, and roles", + "description": "Retrieve CSV data of accounts, groups, and roles information", + "tags": ["authorization"], + "parameters": [], + "operationId": "Authorization.exportAuthReport", + "responses": { + "200": { + "description": "Result of export", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Authorization.admin", "Authorization.apiread"], + "CookieAuth": ["Authorization.admin", "Authorization.apiread"], + "BasicAuth": ["Authorization.admin", "Authorization.apiread"] + } + ], + "deprecated": false + } + }, + "/device-counts": { + "get": { + "summary": "Get device count history", + "description": "Get device count history", + "tags": ["device-counts"], + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "type": "string", + "enum": ["newest", "oldest"], + "default": "newest" + } + }, + { + "name": "serverId", + "in": "query", + "description": "The server ID where the device counts came from", + "required": false, + "schema": { + "type": "string", + "description": "The server ID where the device counts came from" + } + }, + { + "name": "before", + "in": "query", + "description": "The timestamp in milliseconds used as an upper range. Should be higher than the after value.", + "required": false, + "schema": { + "type": "integer", + "description": "The timestamp in milliseconds used as an upper range. Should be higher than the after value." + } + }, + { + "name": "after", + "in": "query", + "description": "The timestamp in milliseconds used as a lower range. Should be lower than the after value.", + "required": false, + "schema": { + "type": "integer", + "description": "The timestamp in milliseconds used as a lower range. Should be lower than the after value." + } + } + ], + "operationId": "DeviceCounts.getDeviceCounts", + "responses": { + "200": { + "description": "The device counts matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_device-count-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["DeviceCounts.admin"], + "CookieAuth": ["DeviceCounts.admin"], + "BasicAuth": ["DeviceCounts.admin"] + } + ], + "deprecated": false + } + }, + "/device-counts/refresh": { + "post": { + "summary": "Refresh device count history", + "description": "Refresh device count history", + "tags": ["device-counts"], + "parameters": [], + "operationId": "DeviceCounts.createDeviceCount", + "responses": { + "200": { + "description": "Refresh device count history", + "content": { + "application/json": { + "schema": {} + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["DeviceCounts.admin"], + "CookieAuth": ["DeviceCounts.admin"], + "BasicAuth": ["DeviceCounts.admin"] + } + ], + "deprecated": false + } + }, + "/health/adapters/{name}": { + "get": { + "summary": "Get the health of a single adapter.", + "description": "Get the health of a single adapter in IAP.", + "tags": ["health"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected adapter.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Health.getAdapterHealth", + "responses": { + "200": { + "description": "Contains the selected adapters health data.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_services-health-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/applications/{name}": { + "get": { + "summary": "Get the health of a single application.", + "description": "Get the health of a single application in IAP.", + "tags": ["health"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name for the selected application.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_services-schema_name" + } + } + ], + "operationId": "Health.getApplicationHealth", + "responses": { + "200": { + "description": "Contains the selected applications health data.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_services-health-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/adapters": { + "get": { + "summary": "Get the health of all the adapters.", + "description": "Get the health of all the adapters in IAP.", + "tags": ["health"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Health.getAdaptersHealth", + "responses": { + "200": { + "description": "Contains the adapters health data.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_services-health-schema" + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/applications": { + "get": { + "summary": "Get the health of all the applications.", + "description": "Get the health of all the applications in IAP.", + "tags": ["health"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Health.getApplicationsHealth", + "responses": { + "200": { + "description": "Contains the applications health data.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_services-health-schema" + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/server": { + "get": { + "summary": "Get the health of the server.", + "description": "Get the health of the server.", + "tags": ["health"], + "parameters": [], + "operationId": "Health.getServerHealth", + "responses": { + "200": { + "description": "Contains the server health data.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "release": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "arch": { + "type": "string", + "enum": [ + "arm", + "arm64", + "ia32", + "mips", + "mipsel", + "ppc", + "ppc64", + "s390", + "s390x", + "x32", + "x64" + ] + }, + "platform": { + "type": "string", + "enum": [ + "aix", + "darwin", + "freebsd", + "linux", + "openbsd", + "sunos", + "win32" + ] + }, + "versions": { + "type": "object", + "properties": { + "node": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "v8": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "uv": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "zlib": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "brotli": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "ares": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "modules": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "nghttp2": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "napi": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "llhttp": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "http_parser": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "openssl": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "cldr": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "icu": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "tz": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "unicode": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + } + } + }, + "memoryUsage": { + "$ref": "#/components/schemas/iap_services-health-schema_memoryUsage" + }, + "cpuUsage": { + "$ref": "#/components/schemas/iap_services-health-schema_cpuUsage" + }, + "uptime": { + "$ref": "#/components/schemas/iap_services-health-schema_uptime" + }, + "pid": { + "$ref": "#/components/schemas/iap_services-health-schema_pid" + }, + "dependencies": { + "type": "object", + "properties": { + "@itential/logger": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "@itential/database": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "@itential/itential-utils": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/system": { + "get": { + "summary": "Get the health of the system.", + "description": "Get the health of the system.", + "tags": ["health"], + "parameters": [], + "operationId": "Health.getSystemHealth", + "responses": { + "200": { + "description": "Contains the system health data.", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "results", + "properties": { + "arch": { + "type": "string", + "examples": ["x64"] + }, + "release": { + "$ref": "#/components/schemas/iap_services-health-schema_version" + }, + "uptime": { + "type": "integer", + "examples": [12539] + }, + "freemem": { + "type": "integer", + "examples": [14377422848] + }, + "totalmem": { + "type": "integer", + "examples": [34359738368] + }, + "loadavg": { + "type": "array", + "items": { + "type": "number", + "examples": [3.0166015625, 1.74169921875] + } + }, + "cpus": { + "type": "array", + "items": { + "type": "object", + "required": ["model", "speed", "times"], + "properties": { + "model": { + "type": "string", + "examples": [ + "Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz" + ] + }, + "speed": { + "type": "integer", + "examples": [2300] + }, + "times": { + "type": "object", + "required": ["user", "nice", "sys", "idle", "irq"], + "properties": { + "user": { + "type": "integer", + "examples": [604790] + }, + "nice": { + "type": "integer", + "examples": [0] + }, + "sys": { + "type": "integer", + "examples": [322560] + }, + "idle": { + "type": "integer", + "examples": [6071010] + }, + "irq": { + "type": "integer", + "examples": [0] + } + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Health.admin", "Health.apiread"], + "CookieAuth": ["Health.admin", "Health.apiread"], + "BasicAuth": ["Health.admin", "Health.apiread"] + } + ], + "deprecated": false + } + }, + "/health/status": { + "get": { + "summary": "Get status.", + "description": "Get status of current IAP.", + "tags": ["health"], + "parameters": [], + "operationId": "Health.getHealthStatus", + "responses": { + "200": { + "description": "status of the current IAP.", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "serverId": { + "type": "string" + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "service": { + "type": "string" + }, + "status": { + "type": "string", + "enum": ["running", "failed"] + } + } + } + }, + "timestamp": { + "type": "integer" + }, + "apps": { + "type": "string", + "enum": ["running", "degraded"] + }, + "adapters": { + "type": "string", + "enum": ["running", "degraded"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/prebuilts/{id}/export": { + "get": { + "summary": "Export a prebuilt", + "description": "Export a prebuilt from IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The object id of the selected prebuilt.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Prebuilts.exportPrebuilt", + "responses": { + "200": { + "description": "The data for a prebuilt.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] + } + ], + "deprecated": false + } + }, + "/prebuilts/{id}": { + "get": { + "summary": "Get a single prebuilt.", + "description": "Get a single prebuilt in IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The object id of the selected prebuilt.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Prebuilts.getPrebuilt", + "responses": { + "200": { + "description": "The data for a prebuilt.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Remove a prebuilt.", + "description": "Remove a prebuilt from IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The object id of the selected prebuilt.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Prebuilts.removePrebuilt", + "responses": { + "200": { + "description": "The output of the prebuilt removal process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Prebuilts.admin"], + "CookieAuth": ["Prebuilts.admin"], + "BasicAuth": ["Prebuilts.admin"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update a prebuilt", + "description": "Update a prebuilt in IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The object id of the selected prebuilt.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_objectId" + } + } + ], + "operationId": "Prebuilts.updatePrebuilt", + "responses": { + "200": { + "description": "The output of the prebuilt update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Prebuilts.admin"], + "CookieAuth": ["Prebuilts.admin"], + "BasicAuth": ["Prebuilts.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prebuilt": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + } + } + } + } + }, + "/prebuilts": { + "get": { + "summary": "Get all the prebuilts.", + "description": "Get all the prebuilts in IAP.", + "tags": ["prebuilts"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["nso"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["artifact-wizard"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["n", "a"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "config", + "in": "query", + "description": "config", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_config" + } + } + ], + "operationId": "Prebuilts.getPrebuilts", + "responses": { + "200": { + "description": "Contains an array of prebuilts and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "required": ["packages", "total"], + "properties": { + "packages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], + "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] + } + ], + "deprecated": false + } + }, + "/prebuilts/import": { + "post": { + "summary": "Import a prebuilt.", + "description": "Import a prebuilt into IAP.", + "tags": ["prebuilts"], + "parameters": [], + "operationId": "Prebuilts.importPrebuilt", + "responses": { + "200": { + "description": "The output of the prebuilt import process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Prebuilts.admin"], + "CookieAuth": ["Prebuilts.admin"], + "BasicAuth": ["Prebuilts.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prebuilt": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "overwrite": { + "type": "boolean", + "description": "If the import functionality should overwrite existing components", + "examples": [true, false] + } + } + } + } + } + } + } + } + } + }, + "/prebuilts/import/validation": { + "put": { + "summary": "Validate the data structure of a prebuilt.", + "description": "Validate the data structure of a prebuilt in IAP.", + "tags": ["prebuilts"], + "parameters": [], + "operationId": "Prebuilts.validatePrebuilt", + "responses": { + "200": { + "description": "The output of the prebuilt update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Prebuilts.admin"], + "CookieAuth": ["Prebuilts.admin"], + "BasicAuth": ["Prebuilts.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prebuilt": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + } + } + } + } + }, + "/external-links": { + "get": { + "summary": "Get all links.", + "description": "Get all links", + "tags": ["external-links"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_links-query" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_links-query" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_links-query" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "ExternalLinks.getLinks", + "responses": { + "200": { + "description": "The links matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_links-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], + "CookieAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], + "BasicAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Update a link.", + "description": "Create a link", + "tags": ["external-links"], + "parameters": [], + "operationId": "ExternalLinks.createLink", + "responses": { + "200": { + "description": "Result of link creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_links-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["ExternalLinks.admin"], + "CookieAuth": ["ExternalLinks.admin"], + "BasicAuth": ["ExternalLinks.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "link": { + "$ref": "#/components/schemas/iap_links-schema" + } + } + } + } + } + } + } + }, + "/external-links/{linkId}": { + "get": { + "summary": "Get an individual link.", + "description": "Get an individual link", + "tags": ["external-links"], + "parameters": [ + { + "name": "linkId", + "in": "path", + "description": "The id for the requested link.", + "required": true, + "schema": { + "title": "linkId", + "type": "string" + } + } + ], + "operationId": "ExternalLinks.getLink", + "responses": { + "200": { + "description": "The individual link document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_links-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], + "CookieAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], + "BasicAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update a link.", + "description": "Update a link", + "tags": ["external-links"], + "parameters": [ + { + "name": "linkId", + "in": "path", + "description": "The individual link to update.", + "required": true, + "schema": { + "title": "linkId", + "type": "string" + } + } + ], + "operationId": "ExternalLinks.updateLink", + "responses": { + "200": { + "description": "The output of the link update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_links-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["ExternalLinks.admin"], + "CookieAuth": ["ExternalLinks.admin"], + "BasicAuth": ["ExternalLinks.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_links-schema_name" + }, + "address": { + "$ref": "#/components/schemas/iap_links-schema_address" + }, + "description": { + "$ref": "#/components/schemas/iap_links-schema_description" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a link.", + "description": "Delete a link", + "tags": ["external-links"], + "parameters": [ + { + "name": "linkId", + "in": "path", + "description": "The individual link to delete.", + "required": true, + "schema": { + "title": "linkId", + "type": "string" + } + } + ], + "operationId": "ExternalLinks.deleteLink", + "responses": { + "200": { + "description": "Result of link deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["ExternalLinks.admin"], + "CookieAuth": ["ExternalLinks.admin"], + "BasicAuth": ["ExternalLinks.admin"] + } + ], + "deprecated": false + } + }, + "/prebuilts-repository/configs": { + "post": { + "summary": "Create repository configuration", + "description": "Create a new repository configuration", + "tags": ["prebuilts-repository"], + "parameters": [], + "operationId": "PrebuiltsRepository.createRepositoryConfig", + "responses": { + "200": { + "description": "The result of the creation process", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_repository-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "config": { + "$ref": "#/components/schemas/iap_repository-schema" + } + } + } + } + } + } + }, + "get": { + "summary": "Get Repository Configurations", + "description": "Get all the Prebuilt Repository configurations", + "tags": ["prebuilts-repository"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["redis"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["name"] + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "PrebuiltsRepository.getRepositoryConfigs", + "responses": { + "200": { + "description": "Contains an array of prebuilts and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "required": ["results", "total"], + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_prebuilts-schema_name" + }, + "enabled": { + "$ref": "#/components/schemas/iap_repository-schema_enabled" + }, + "type": { + "$ref": "#/components/schemas/iap_repository-schema_type" + }, + "hostname": { + "$ref": "#/components/schemas/iap_repository-schema_hostname" + }, + "path": { + "$ref": "#/components/schemas/iap_repository-schema_path" + }, + "credentials": { + "$ref": "#/components/schemas/iap_repository-schema_credentials" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false + } + }, + "/prebuilts-repository/configs/{name}": { + "delete": { + "summary": "Delete repository configuration", + "description": "Delete an existing repository configuration", + "tags": ["prebuilts-repository"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the repository configuration", + "required": true, + "schema": { + "title": "name", + "type": "string" + } + } + ], + "operationId": "PrebuiltsRepository.deleteRepositoryConfig", + "responses": { + "200": { + "description": "The result of the delete process", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update repository configuration", + "description": "Update an existing repository configuration", + "tags": ["prebuilts-repository"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the repository configuration", + "required": true, + "schema": { + "title": "name", + "type": "string" + } + } + ], + "operationId": "PrebuiltsRepository.updateRepositoryConfig", + "responses": { + "200": { + "description": "The result of the update process", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_repository-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "A flag that denotes if the repository configuration is connected" + }, + "type": { + "type": "string", + "description": "The type of Repository", + "enum": ["gitlab"] + }, + "hostname": { + "type": "string", + "description": "The hostname of the Respository endpoint", + "examples": ["gitlab.com"] + }, + "path": { + "type": "string", + "description": "The path of the Repository endpoint", + "examples": ["itentialopensource/pre-built-automations"] + }, + "credentials": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "An access token used to make HTTP requests", + "examples": ["uTc_P4pnMAEsLbQHmyOt"] + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + } + } + }, + "/prebuilts-repository": { + "get": { + "summary": "Get all prebuilts", + "description": "Get all prebuilts from a repository.", + "tags": ["prebuilts-repository"], + "parameters": [ + { + "name": "page", + "in": "query", + "description": "The page number for the request return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "The page number for the request return. Used for pagination.", + "default": 1, + "minimum": 1, + "examples": [1, 3, 5] + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + }, + { + "name": "iap_version", + "in": "query", + "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.", + "required": false, + "schema": { + "type": "number", + "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.", + "examples": [2019.3, 2020.1] + } + }, + { + "name": "search", + "in": "query", + "description": "Search all available artifacts to find a match related to the provided query.", + "required": false, + "schema": { + "type": "string", + "description": "Search all available artifacts to find a match related to the provided query.", + "examples": ["device", "nso"] + } + }, + { + "name": "config", + "in": "query", + "description": "config", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_config" + } + }, + { + "name": "versionStatus", + "in": "query", + "description": "Filter the list of Pre-builts based on the available version of the Pre-built in comparison to the current version of IAP", + "required": false, + "schema": { + "type": "string", + "description": "Filter the list of Pre-builts based on the available version of the Pre-built in comparison to the current version of IAP", + "enum": ["latest", "current"] + } + } + ], + "operationId": "PrebuiltsRepository.getRepositoryPrebuilts", + "responses": { + "200": { + "description": "Contains an array of prebuilts and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "required": ["results", "total"], + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "versionStatus": { + "type": "object", + "properties": { + "status": { + "type": "string", + "examples": ["current"] + }, + "iap_version": { + "type": "string", + "examples": ["release/2020.1"] + } + } + }, + "installStatus": { + "type": "object", + "properties": { + "installable": { + "type": "boolean", + "enum": [true, false] + }, + "missingDependencies": { + "oneOf": [ + { + "type": "object", + "description": "A list of every dependency in the prebuilt that is missing from the running system." + }, + { + "type": "null" + } + ] + }, + "mismatchingDependencies": { + "oneOf": [ + { + "type": "object", + "description": "A list of every dependency in the prebuilt that has a version greater than the version of the service running on the system." + }, + { + "type": "null" + } + ] + } + } + }, + "availableUpdate": { + "oneOf": [ + { + "type": "boolean", + "enum": [true, false] + }, + { + "type": "null" + } + ] + }, + "name": { + "$ref": "#/components/schemas/iap_prebuilts-schema_name" + }, + "version": { + "$ref": "#/components/schemas/iap_prebuilts-schema_version" + }, + "description": { + "$ref": "#/components/schemas/iap_prebuilts-schema_description" + }, + "author": { + "$ref": "#/components/schemas/iap_prebuilts-schema_author" + }, + "published": { + "type": "string", + "examples": ["2020-04-09T17:44:30.215Z"], + "format": "date-time" + }, + "repository": { + "$ref": "#/components/schemas/iap_prebuilts-schema_repository" + }, + "license": { + "$ref": "#/components/schemas/iap_prebuilts-schema_license" + }, + "keywords": { + "$ref": "#/components/schemas/iap_prebuilts-schema_keywords" + }, + "IAPDependencies": { + "$ref": "#/components/schemas/iap_prebuilts-schema_IAPDependencies" + }, + "readme": { + "$ref": "#/components/schemas/iap_prebuilts-schema_readme" + }, + "download": { + "$ref": "#/components/schemas/iap_prebuilts-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + }, + "page": { + "type": "integer" + }, + "total-pages": { + "type": "integer" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "CookieAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ], + "BasicAuth": [ + "PrebuiltsRepository.admin", + "PrebuiltsRepository.apiread" + ] + } + ], + "deprecated": false + } + }, + "/sso/configs": { + "post": { + "summary": "Create an SSO configuration", + "description": "Create an SSO configuration", + "tags": ["sso"], + "parameters": [], + "operationId": "SSO.createSSOConfig", + "responses": { + "200": { + "description": "The result of the SSO config creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSO.admin"], + "CookieAuth": ["SSO.admin"], + "BasicAuth": ["SSO.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + } + } + } + }, + "get": { + "summary": "Get all SSO configurations", + "description": "Get all SSO configurations", + "tags": ["sso"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["GitHub"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "enum": [ + "name", + "samlEmailAttribute", + "samlUserNameAttribute", + "samlGroupsAttribute", + "samlFirstNameAttribute", + "ssoType" + ] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["Okta"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "enum": [ + "name", + "samlEmailAttribute", + "samlUserNameAttribute", + "samlGroupsAttribute", + "samlFirstNameAttribute", + "ssoType" + ] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["Okta"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "enum": [ + "name", + "samlEmailAttribute", + "samlUserNameAttribute", + "samlGroupsAttribute", + "samlFirstNameAttribute", + "ssoType" + ] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "SSO.getSSOConfigs", + "responses": { + "200": { + "description": "Contains an array of SSO configurations and the total in the response.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/iap_sso-schema" + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSO.admin", "SSO.apiread"], + "CookieAuth": ["SSO.admin", "SSO.apiread"], + "BasicAuth": ["SSO.admin", "SSO.apiread"] + } + ], + "deprecated": false + } + }, + "/sso/configs/{name}": { + "delete": { + "summary": "Delete an SSO configuration", + "description": "Delete an SSO configuration", + "tags": ["sso"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration to delete", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "SSO.deleteSSOConfig", + "responses": { + "200": { + "description": "The result of the SSO config deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSO.admin"], + "CookieAuth": ["SSO.admin"], + "BasicAuth": ["SSO.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a single SSO configuration", + "description": "Get a single SSO configuration", + "tags": ["sso"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration to get", + "required": true, + "schema": { + "title": "name", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "SSO.getSSOConfig", + "responses": { + "200": { + "description": "The SSO configuration document", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSO.admin", "SSO.apiread"], + "CookieAuth": ["SSO.admin", "SSO.apiread"], + "BasicAuth": ["SSO.admin", "SSO.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update an SSO configuration", + "description": "Update an SSO configuration", + "tags": ["sso"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration to delete", + "required": true, + "schema": { + "title": "result", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "SSO.updateSSOConfig", + "responses": { + "200": { + "description": "The result of the SSO config update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSO.admin"], + "CookieAuth": ["SSO.admin"], + "BasicAuth": ["SSO.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/iap_sso-schema" + } + } + } + } + } + } + } + }, + "/sso/configs/{name}/active": { + "post": { + "summary": "Activate an SSO configuration", + "description": "Activate an SSO configuration", + "tags": ["sso"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the SSO configuration to delete", + "required": true, + "schema": { + "title": "result", + "type": "string", + "examples": ["Auth0", "Okta"] + } + } + ], + "operationId": "SSO.setSSOConfigActive", + "responses": { + "200": { + "description": "The result of the SSO config update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSO.admin"], + "CookieAuth": ["SSO.admin"], + "BasicAuth": ["SSO.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "active": { + "title": "active", + "type": "boolean" + } + } + } + } + } + } + } + }, + "/prometheus_metrics": { + "get": { + "summary": "Get prometheus metrics.", + "description": "Builds and returns all prometheus metrics.", + "tags": ["prometheus_metrics"], + "parameters": [], + "operationId": "PrometheusMetrics.getPrometheusMetrics", + "responses": { + "200": { + "description": "result", + "content": { + "application/json": { + "schema": { + "title": "result", + "description": "Metrics to be ingested by prometheus.", + "type": "string" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false + } + }, + "/group-mappings": { + "get": { + "summary": "Get all group mappings.", + "description": "Get all group mappings", + "tags": ["group-mappings"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "expand", + "in": "query", + "description": "Sets the fields to expand", + "required": false, + "schema": { + "type": "string", + "title": "List of fields to get expanded data", + "description": "Sets the fields to expand", + "examples": ["iapGroups"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "SSOGroupMappings.getGroupMappings", + "responses": { + "200": { + "description": "The group mappings matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "$ref": "#/components/schemas/iap_mapping-schema" + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"], + "CookieAuth": [ + "SSOGroupMappings.admin", + "SSOGroupMappings.apiread" + ], + "BasicAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Create a group mapping.", + "description": "Create a group mapping", + "tags": ["group-mappings"], + "parameters": [], + "operationId": "SSOGroupMappings.createGroupMapping", + "responses": { + "200": { + "description": "Result of group mapping creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_mapping-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSOGroupMappings.admin"], + "CookieAuth": ["SSOGroupMappings.admin"], + "BasicAuth": ["SSOGroupMappings.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupMapping": { + "$ref": "#/components/schemas/iap_mapping-schema" + } + } + } + } + } + } + } + }, + "/group-mappings/{provenance}/{externalGroup}": { + "get": { + "summary": "Get an individual group mapping.", + "description": "Get an individual group mapping", + "tags": ["group-mappings"], + "parameters": [ + { + "name": "provenance", + "in": "path", + "description": "The provenance for the requested group mapping.", + "required": true, + "schema": { + "title": "provenance", + "type": "string" + } + }, + { + "name": "externalGroup", + "in": "path", + "description": "The name of the external group that is mapped.", + "required": true, + "schema": { + "title": "externalGroup", + "type": "string" + } + } + ], + "operationId": "SSOGroupMappings.getGroupMapping", + "responses": { + "200": { + "description": "The individual group mapping document.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_mapping-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"], + "CookieAuth": [ + "SSOGroupMappings.admin", + "SSOGroupMappings.apiread" + ], + "BasicAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update a group mapping.", + "description": "Update a group mapping", + "tags": ["group-mappings"], + "parameters": [ + { + "name": "provenance", + "in": "path", + "description": "The provenance for the requested group mapping.", + "required": true, + "schema": { + "title": "provenance", + "type": "string" + } + }, + { + "name": "externalGroup", + "in": "path", + "description": "The individual group mapping to update.", + "required": true, + "schema": { + "title": "externalGroup", + "type": "string" + } + } + ], + "operationId": "SSOGroupMappings.updateGroupMapping", + "responses": { + "200": { + "description": "The output of the group mapping update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_mapping-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSOGroupMappings.admin"], + "CookieAuth": ["SSOGroupMappings.admin"], + "BasicAuth": ["SSOGroupMappings.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "iapGroups": { + "$ref": "#/components/schemas/iap_mapping-schema_iapGroups" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a group mapping.", + "description": "Delete a group mapping", + "tags": ["group-mappings"], + "parameters": [ + { + "name": "provenance", + "in": "path", + "description": "The provenance for the requested group mapping.", + "required": true, + "schema": { + "title": "provenance", + "type": "string" + } + }, + { + "name": "externalGroup", + "in": "path", + "description": "The individual group mapping to delete.", + "required": true, + "schema": { + "title": "externalGroup", + "type": "string" + } + } + ], + "operationId": "SSOGroupMappings.deleteGroupMapping", + "responses": { + "200": { + "description": "Result of group mapping deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["SSOGroupMappings.admin"], + "CookieAuth": ["SSOGroupMappings.admin"], + "BasicAuth": ["SSOGroupMappings.admin"] + } + ], + "deprecated": false + } + }, + "/git/{gitType}/repos/{repoPath}/branches/{branchName}/projects/{projectPath}": { + "get": { + "summary": "Retrieve a project from Git", + "description": "Retrieve a project from Git", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + }, + { + "name": "branchName", + "in": "path", + "description": "The name of the branch that is used.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_branchName" + } + }, + { + "name": "projectPath", + "in": "path", + "description": "The file path within a Git repository to a project file", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_projectPath" + } + } + ], + "operationId": "Git.getProject", + "responses": { + "200": { + "description": "The exact contents of the project file stored in Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + }, + "post": { + "summary": "Initialize a project in Git", + "description": "Initialize a project in Git", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + }, + { + "name": "branchName", + "in": "path", + "description": "The name of the branch that is used.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_branchName" + } + }, + { + "name": "projectPath", + "in": "path", + "description": "The file path within a Git repository to a project file", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_projectPath" + } + }, + { + "name": "project", + "in": "path", + "description": "The project document being pushed to Git", + "required": true, + "schema": { + "title": "project", + "type": "object" + } + } + ], + "operationId": "Git.initProject", + "responses": { + "200": { + "description": "The result of initializing a project in Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully initialized project"] + }, + "data": { + "type": "object", + "description": "The project document pushed to Git" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commitMessage": { + "$ref": "#/components/schemas/iap_git-common_commitMessage" + } + } + } + } + } + } + }, + "put": { + "summary": "Update a project in Git", + "description": "Update a project in Git", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + }, + { + "name": "branchName", + "in": "path", + "description": "The name of the branch that is used.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_branchName" + } + }, + { + "name": "projectPath", + "in": "path", + "description": "The file path within a Git repository to a project file", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_projectPath" + } + }, + { + "name": "project", + "in": "path", + "description": "The project document being pushed to Git", + "required": true, + "schema": { + "title": "project", + "type": "object" + } + } + ], + "operationId": "Git.updateProject", + "responses": { + "200": { + "description": "The result of updating a project in Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully updated project"] + }, + "data": { + "type": "object", + "description": "The project document pushed to Git" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commitMessage": { + "$ref": "#/components/schemas/iap_git-common_commitMessage" + } + } + } + } + } + } + } + }, + "/git/{gitType}/repos/{repoPath}/branches": { + "post": { + "summary": "Create a new branch in a repository", + "description": "Create a new branch in a repository", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + } + ], + "operationId": "Git.createBranch", + "responses": { + "200": { + "description": "The result of creating a branch", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully created branch: exampleBranch"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "originBranch": { + "$ref": "#/components/schemas/iap_git-common_branchName" + }, + "newBranch": { + "$ref": "#/components/schemas/iap_git-common_branchName" + } + } + } + } + } + } + }, + "get": { + "summary": "List the available branches for a repository", + "description": "List the available branches for a repository", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + } + ], + "operationId": "Git.listBranches", + "responses": { + "200": { + "description": "The result of retrieving a list of branches from Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "The name of the branch", + "type": "string", + "examples": ["main"] + }, + "protected": { + "description": "Whether or not the branch is protected", + "type": "boolean" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false + } + }, + "/git/{gitType}/repos/{repoPath}": { + "post": { + "summary": "Create a new repository in Git for storing projects", + "description": "Create a new repository in Git for storing projects", + "tags": ["git"], + "parameters": [ + { + "name": "gitType", + "in": "path", + "description": "The name of the Git provider that is used", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_type" + } + }, + { + "name": "repoPath", + "in": "path", + "description": "The path in Git to the repository", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_git-common_repoPath" + } + } + ], + "operationId": "Git.createRepo", + "responses": { + "200": { + "description": "The result of creating a repository in Git", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": [ + "`Successfully created repository: ExampleRepo" + ] + }, + "data": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The full path to the repository in Git", + "examples": [ + "group1/group2/ExampleRepo", + "exampleOrg/ExampleRepo" + ] + }, + "default_branch": { + "type": "string", + "description": "The default branch created for the repository", + "examples": ["main"] + }, + "visibility": { + "type": "string", + "description": "The visibility of the repository", + "examples": ["private"] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repoName": { + "title": "repoName", + "type": "string", + "examples": ["RepositoryName"] + } + } + } + } + } + } + } + }, + "/profiles": { + "post": { + "summary": "Creates a new profile", + "description": "Create a new profile in IAP.", + "tags": ["profiles"], + "parameters": [], + "operationId": "Profiles.createProfile", + "responses": { + "200": { + "description": "The output of the profile creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "uiProps": { + "$ref": "#/components/schemas/iap_profiles-schema_uiProps" + }, + "authenticationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" + }, + "expressProps": { + "$ref": "#/components/schemas/iap_profiles-schema_expressProps" + }, + "loggerProps": { + "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" + }, + "redisProps": { + "$ref": "#/components/schemas/iap_profiles-schema_redisProps" + }, + "auditProps": { + "$ref": "#/components/schemas/iap_profiles-schema_auditProps" + }, + "pathProps": { + "$ref": "#/components/schemas/iap_profiles-schema_pathProps" + }, + "alarmProps": { + "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" + }, + "id": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + }, + "services": { + "$ref": "#/components/schemas/iap_profiles-schema_services" + }, + "description": { + "$ref": "#/components/schemas/iap_profiles-schema_description" + }, + "adapterStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" + }, + "systemProps": { + "$ref": "#/components/schemas/iap_profiles-schema_systemProps" + }, + "integrationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" + }, + "retryStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" + }, + "serviceDirectory": { + "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" + } + }, + "required": ["id"] + } + } + } + } + } + } + }, + "get": { + "summary": "Get all profiles.", + "description": "Get all the profiles in IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "type": "string", + "examples": ["profile1"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string", + "examples": ["id"] + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "string", + "examples": ["profile1"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "equalsField", + "required": false, + "schema": { + "type": "string", + "examples": ["id"] + } + }, + { + "name": "startsWith", + "in": "query", + "description": "startsWith", + "required": false, + "schema": { + "type": "string", + "examples": ["profile"] + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "startsWithField", + "required": false, + "schema": { + "type": "string", + "examples": ["id"] + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "Profiles.getProfiles", + "responses": { + "200": { + "description": "Contains the data of a profile.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + } + }, + "profile": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Profiles.admin", "Profiles.apiread"], + "CookieAuth": ["Profiles.admin", "Profiles.apiread"], + "BasicAuth": ["Profiles.admin", "Profiles.apiread"] + } + ], + "deprecated": false + } + }, + "/profiles/import": { + "post": { + "summary": "Import a new profile", + "description": "Import a new profile in IAP.", + "tags": ["profiles"], + "parameters": [], + "operationId": "Profiles.importProfile", + "responses": { + "200": { + "description": "The output of the profile import process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "uiProps": { + "$ref": "#/components/schemas/iap_profiles-schema_uiProps" + }, + "authenticationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" + }, + "expressProps": { + "$ref": "#/components/schemas/iap_profiles-schema_expressProps" + }, + "loggerProps": { + "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" + }, + "redisProps": { + "$ref": "#/components/schemas/iap_profiles-schema_redisProps" + }, + "auditProps": { + "$ref": "#/components/schemas/iap_profiles-schema_auditProps" + }, + "pathProps": { + "$ref": "#/components/schemas/iap_profiles-schema_pathProps" + }, + "alarmProps": { + "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" + }, + "id": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + }, + "services": { + "$ref": "#/components/schemas/iap_profiles-schema_services" + }, + "description": { + "$ref": "#/components/schemas/iap_profiles-schema_description" + }, + "adapterStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" + }, + "systemProps": { + "$ref": "#/components/schemas/iap_profiles-schema_systemProps" + }, + "integrationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" + }, + "retryStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" + }, + "serviceDirectory": { + "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" + }, + "migrationVersion": { + "type": "integer", + "minimum": 0 + } + }, + "required": ["id"] + } + } + } + } + } + } + } + }, + "/profiles/{id}": { + "delete": { + "summary": "Delete a profile.", + "description": "Delete a profile from IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.deleteProfile", + "responses": { + "200": { + "description": "The output of the profile deletion process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get a single profile.", + "description": "Get a single profile in the current IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.getProfile", + "responses": { + "200": { + "description": "Contains the metadata and data of a profile.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "isActive": { + "$ref": "#/components/schemas/iap_common-schema_isActive" + }, + "activeSync": { + "$ref": "#/components/schemas/iap_common-schema_activeSync" + } + } + }, + "profile": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Profiles.admin", "Profiles.apiread"], + "CookieAuth": ["Profiles.admin", "Profiles.apiread"], + "BasicAuth": ["Profiles.admin", "Profiles.apiread"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates a profile.", + "description": "Update a profile in IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.updateProfile", + "responses": { + "200": { + "description": "The output of the update process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "title": "properties", + "type": "object", + "properties": { + "uiProps": { + "$ref": "#/components/schemas/iap_profiles-schema_uiProps" + }, + "authenticationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" + }, + "expressProps": { + "$ref": "#/components/schemas/iap_profiles-schema_expressProps" + }, + "loggerProps": { + "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" + }, + "redisProps": { + "$ref": "#/components/schemas/iap_profiles-schema_redisProps" + }, + "auditProps": { + "$ref": "#/components/schemas/iap_profiles-schema_auditProps" + }, + "pathProps": { + "$ref": "#/components/schemas/iap_profiles-schema_pathProps" + }, + "alarmProps": { + "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" + }, + "id": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + }, + "services": { + "$ref": "#/components/schemas/iap_profiles-schema_services" + }, + "description": { + "$ref": "#/components/schemas/iap_profiles-schema_description" + }, + "adapterStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" + }, + "systemProps": { + "$ref": "#/components/schemas/iap_profiles-schema_systemProps" + }, + "integrationProps": { + "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" + }, + "retryStrategy": { + "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" + }, + "serviceDirectory": { + "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/profiles/{id}/export": { + "get": { + "summary": "Export a single profile.", + "description": "Exports a single profile in the current IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.exportProfile", + "responses": { + "200": { + "description": "Contains the metadata and data of a profile.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Profiles.admin", "Profiles.apiread"], + "CookieAuth": ["Profiles.admin", "Profiles.apiread"], + "BasicAuth": ["Profiles.admin", "Profiles.apiread"] + } + ], + "deprecated": false + } + }, + "/profiles/{id}/active": { + "put": { + "summary": "Switch the active profile.", + "description": "Switch the active profile in the current IAP.", + "tags": ["profiles"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Contains the id for the selected profile.", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_profiles-schema_id" + } + } + ], + "operationId": "Profiles.switchActiveProfile", + "responses": { + "200": { + "description": "The output of the profile creation process.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Profiles.admin"], + "CookieAuth": ["Profiles.admin"], + "BasicAuth": ["Profiles.admin"] + } + ], + "deprecated": true + } + }, + "/oauth/serviceAccounts": { + "post": { + "summary": "Create a service account in the database.", + "description": "Create a service account in the database.", + "tags": ["oauth"], + "parameters": [], + "operationId": "OAuth.createServiceAccount", + "responses": { + "200": { + "description": "result", + "content": { + "application/json": { + "schema": { + "title": "result", + "description": "The client credentials for a new service account", + "type": "object", + "properties": { + "client_id": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + }, + "client_secret": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "accountData": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + } + } + } + } + } + }, + "get": { + "summary": "Get service accounts from the database.", + "description": "Get service accounts from the database.", + "tags": ["oauth"], + "parameters": [ + { + "name": "multiContains", + "in": "query", + "description": "multiContains", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + }, + { + "name": "multiEquals", + "in": "query", + "description": "multiEquals", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + }, + { + "name": "multiStartsWith", + "in": "query", + "description": "multiStartsWith", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_limit" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_sort" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/iap_common-schema_order" + } + } + ], + "operationId": "OAuth.getServiceAccounts", + "responses": { + "200": { + "description": "The service accounts matching the specified query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/iap_service-accounts-schema_name" + }, + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + }, + "client_id": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" + }, + "createdBy": { + "$ref": "#/components/schemas/iap_service-accounts-schema_modifiedByDereferenced" + }, + "updated": { + "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" + }, + "updatedBy": { + "$ref": "#/components/schemas/iap_service-accounts-schema_modifiedByDereferenced" + }, + "secretUpdated": { + "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" + } + } + } + } + } + }, + "total": { + "$ref": "#/components/schemas/iap_common-schema_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false + } + }, + "/oauth/serviceAccounts/{client_id}": { + "patch": { + "summary": "Updates a service account in the database.", + "description": "Updates a service account in the database.", + "tags": ["oauth"], + "parameters": [ + { + "name": "client_id", + "in": "path", + "description": "The clientId for the service account", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + } + } + ], + "operationId": "OAuth.updateServiceAccount", + "responses": { + "200": { + "description": "The output of the service account update.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + }, + "data": { + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updates": { + "title": "updates", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/iap_service-accounts-schema_description" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Deletes a service account in the database.", + "description": "Deletes a service account in the database.", + "tags": ["oauth"], + "parameters": [ + { + "name": "client_id", + "in": "path", + "description": "The clientId for the service account", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + } + } + ], + "operationId": "OAuth.deleteServiceAccount", + "responses": { + "200": { + "description": "Result of service account deletion process", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/iap_common-schema_status" + }, + "message": { + "$ref": "#/components/schemas/iap_common-schema_message" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false + } + }, + "/oauth/serviceAccounts/{client_id}/regenerate": { + "patch": { + "summary": "Regenerates the client_secret and returns the new value", + "description": "Regenerates the client_secret and returns the new value", + "tags": ["oauth"], + "parameters": [ + { + "name": "client_id", + "in": "path", + "description": "The clientId for the service account", + "required": true, + "schema": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + } + } + ], + "operationId": "OAuth.regenerateSecret", + "responses": { + "200": { + "description": "The new client credentials for a service account", + "content": { + "application/json": { + "schema": { + "title": "result", + "description": "The updated client credentials for an existing service account", + "type": "object", + "properties": { + "client_id": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + }, + "client_secret": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["OAuth.admin"], + "CookieAuth": ["OAuth.admin"], + "BasicAuth": ["OAuth.admin"] + } + ], + "deprecated": false + } + }, + "/oauth/token": { + "post": { + "summary": "Retrieve a JWT from a client's credentials", + "description": "Retrieve a JWT from a client's credentials", + "tags": ["oauth"], + "parameters": [], + "operationId": "OAuth.machineAuthentication", + "responses": { + "200": { + "description": "result", + "content": { + "application/json": { + "schema": { + "title": "result", + "description": "A result containing the JWT providing the user access to IAP for a set amount of time", + "type": "object", + "properties": { + "access_token": { + "description": "The JWT providing the user access to IAP", + "type": "string" + }, + "token_type": { + "description": "The type of token provided", + "type": "string", + "enum": ["bearer"] + }, + "expires_in": { + "description": "The amount of time until the JWT expires", + "type": "integer", + "enum": [3600] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "properties": { + "client_id": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" + }, + "client_secret": { + "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" + }, + "grant_type": { + "type": "string", + "enum": ["client_credentials"] + } + } + } + } + } + } + } + }, + "/transformations/": { + "get": { + "summary": "Search for transformation documents.", + "description": "Search for transformation documents.", + "tags": ["transformations"], + "parameters": [ + { + "name": "incoming", + "in": "query", + "description": "incoming", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "outgoing", + "in": "query", + "description": "outgoing", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "schema", + "in": "query", + "description": "schema", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "contains", + "in": "query", + "description": "contains", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + } + }, + { + "name": "containsField", + "in": "query", + "description": "containsField", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "equals", + "in": "query", + "description": "equals", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "not", + "in": "query", + "description": "not", + "required": false, + "schema": { + "type": "object" + } + }, + { + "name": "expand", + "in": "query", + "description": "expand", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "type": "number" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "type": "number" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "type": "number" + } + }, + { + "name": "exclude-project-members", + "in": "query", + "description": "exclude-project-members", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "operationId": "Jst.searchTransformations", + "responses": { + "200": { + "description": "Transformation documents.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Creates a single transformation.", + "description": "Creates a single transformation.", + "tags": ["transformations"], + "parameters": [], + "operationId": "Jst.createTransformation", + "responses": { + "200": { + "description": "Created transformation document.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "transformation", + "content": { + "application/json": { + "schema": { + "title": "transformation", + "type": "object" + } + } + } + } + } + }, + "/transformations/import": { + "post": { + "summary": "Imports a single transformation.", + "description": "Imports a single transformation.", + "tags": ["transformations"], + "parameters": [], + "operationId": "Jst.importTransformation", + "responses": { + "200": { + "description": "Imported transformation document.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "transformation", + "content": { + "application/json": { + "schema": { + "title": "transformation", + "type": "object" + } + } + } + } + } + }, + "/transformations/{id}": { + "get": { + "summary": "Gets transformation document by id.", + "description": "Gets transformation document by id.", + "tags": ["transformations"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "Jst.getTransformation", + "responses": { + "200": { + "description": "Transformation document.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates a single transformation.", + "description": "Updates a single transformation.", + "tags": ["transformations"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "Jst.updateTransformation", + "responses": { + "200": { + "description": "Updated transformation document.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "transformation", + "content": { + "application/json": { + "schema": { + "title": "transformation", + "type": "object" + } + } + } + } + }, + "delete": { + "summary": "Deletes a single transformation document.", + "description": "Deletes a single transformation document.", + "tags": ["transformations"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "Jst.deleteTransformation", + "responses": { + "200": { + "description": "Deletion result.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Runs a transformation.", + "description": "Runs a transformation.", + "tags": ["transformations"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "Jst.runTransformation", + "responses": { + "200": { + "description": "Transformation run result.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "CookieAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ], + "BasicAuth": [ + "Jst.admin", + "Jst.other", + "Jst.readonly", + "Jst.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "incoming": { + "title": "incoming", + "type": "object" + }, + "options": { + "title": "options", + "type": "object" + } + } + } + } + } + } + } + }, + "/formbuilder/saveForm": { + "post": { + "summary": "Save a Generated Form", + "description": "Save a generated form with its data.", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.saveForm", + "responses": { + "200": { + "description": "Status of save form", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "formData": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + } + } + } + } + }, + "/formbuilder/getFormByName/{form_name}": { + "get": { + "summary": "Get Details of Form by Name", + "description": "Get details for a specific form by name", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "form_name", + "in": "path", + "description": "Form name", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.getFormByName", + "responses": { + "200": { + "description": "Forms details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/preserveFormData": { + "post": { + "summary": "Preserve incoming form data format", + "description": "Find and revert containers object/array mutation", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.preserveFormData", + "responses": { + "200": { + "description": "Forms details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "form_name": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + }, + "data": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + } + } + } + } + }, + "/formbuilder/getForm/{form_id}": { + "get": { + "summary": "Get Details of Form by ID", + "description": "Get details for a specific form from by ID", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "form_id", + "in": "path", + "description": "Form ID", + "required": true, + "schema": { + "title": "form_id", + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + } + } + ], + "operationId": "FormBuilder.getForm", + "responses": { + "200": { + "description": "Forms details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/listForms": { + "get": { + "summary": "List All Form Names", + "description": "List the names of all available forms", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.listForms", + "responses": { + "200": { + "description": "Array of form names", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "array", + "items": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + }, + "uniqueItems": true + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/forms/search": { + "post": { + "summary": "Search Forms", + "description": "Search forms with options", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.searchForms", + "responses": { + "200": { + "description": "Array of objects containing forms", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "array", + "items": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "filter": { + "type": "object", + "examples": [ + { + "name": "form_example_1" + } + ] + }, + "startAt": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "maxResults": { + "type": "integer", + "minimum": 0, + "maximum": 100, + "examples": [10] + }, + "sort": { + "type": "object", + "examples": [ + { + "name": 1 + } + ] + }, + "fields": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "children", + "elements", + "createddBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + "examples": [ + [ + "name", + "children", + "elements", + "createddBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + ], + "uniqueItems": true + }, + "expand": { + "type": "array", + "items": { + "type": "string", + "enum": ["createdBy", "lastUpdatedBy"] + }, + "examples": [["createdBy", "lastUpdatedBy"]], + "uniqueItems": true + } + } + } + } + } + } + } + } + } + }, + "/formbuilder/fetchData": { + "post": { + "summary": "Get Service Instance Data", + "description": "Returns service related data", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.fetchData", + "responses": { + "200": { + "description": "Json object of service instance", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "examples": [ + { + "/ncs:services/test:choices": [ + { + "service-name": "service_name_1", + "choice-a": "1" + } + ] + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "FormBuilder.admin", + "FormBuilder.apiwrite", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiwrite", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiwrite", + "FormBuilder.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "service": { + "title": "service", + "type": "string", + "examples": ["/ncs:devices/ncs:device"] + }, + "instance_key": { + "title": "instance_key", + "type": "string", + "examples": ["ncs:name"] + }, + "val": { + "title": "val", + "type": "string", + "examples": ["my_device_01"] + } + } + } + } + } + } + } + }, + "/formbuilder/getElementDefinition/{type}/{id}": { + "get": { + "summary": "Gets an Element Definition.", + "description": "Get the details about a particular element to be used in a form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Element type", + "required": true, + "schema": { + "title": "type", + "type": "string", + "enum": ["service_model", "method"] + } + }, + { + "name": "id", + "in": "path", + "description": "Type ID", + "required": true, + "schema": { + "title": "id", + "type": "string", + "examples": ["/ncs:services/itential_test_devices:multidevice"] + } + } + ], + "operationId": "FormBuilder.getElementDefinition", + "responses": { + "200": { + "description": "Definition of the element", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "examples": [ + { + "children": [], + "type": "service", + "name": "service-name", + "properties": {}, + "key": "s-key", + "namespace": "", + "hosts": ["nso1", "nso2"] + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/listElements": { + "get": { + "summary": "Lists all Elements Usable in Forms", + "description": "Find all elements allowed to be added to a form", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.listElements", + "responses": { + "200": { + "description": "Array of objects containing elements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_elements" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "CookieAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ], + "BasicAuth": [ + "FormBuilder.admin", + "FormBuilder.apiread", + "FormBuilder.operator" + ] + } + ], + "deprecated": false + } + }, + "/formbuilder/deleteForm/{id}": { + "post": { + "summary": "Delete a Form by ID", + "description": "Delete a form from the database by its ID", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Form ID", + "required": true, + "schema": { + "title": "id", + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + } + } + ], + "operationId": "FormBuilder.deleteForm", + "responses": { + "200": { + "description": "Status of delete", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] + } + ], + "deprecated": false + } + }, + "/formbuilder/forms/{name}/groups": { + "get": { + "summary": "List Groups for a Form", + "description": "List the groups that have access to a Form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.listFormGroups", + "responses": { + "200": { + "description": "List of Groups", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_groups" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["FormBuilder.apiread", "FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.apiread", "FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.apiread", "FormBuilder.authorization"] + } + ], + "deprecated": false + }, + "put": { + "summary": "Overwrite Groups for a Form", + "description": "Overwrite the list of groups that have access to a Form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.replaceFormGroups", + "responses": { + "200": { + "description": "Status of Overwrite", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.authorization"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "$ref": "#/components/schemas/formbuilder_formDocument_groups" + } + } + } + } + } + } + }, + "post": { + "summary": "Add Group to Form", + "description": "Add a group to the list of groups for a Form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.createFormGroupEntry", + "responses": { + "200": { + "description": "Status of Overwrite", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.authorization"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "$ref": "#/components/schemas/formbuilder_formDocument_ObjectId" + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove all authorization restriction for a Form", + "description": "Clear all groups that can access a form, making it accessible to everyone", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + } + ], + "operationId": "FormBuilder.deleteFormGroups", + "responses": { + "200": { + "description": "Status of Delete", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.authorization"] + } + ], + "deprecated": false + } + }, + "/formbuilder/forms/{name}/groups/{group}": { + "delete": { + "summary": "Remove a Group from a Form", + "description": "Remove a group from the list of authorized groups for a Form", + "tags": ["formbuilder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Form", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + }, + { + "name": "group", + "in": "path", + "description": "A Group ID", + "required": true, + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument_ObjectId" + } + } + ], + "operationId": "FormBuilder.removeFormGroup", + "responses": { + "200": { + "description": "Status of Removal", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["FormBuilder.authorization"], + "CookieAuth": ["FormBuilder.authorization"], + "BasicAuth": ["FormBuilder.authorization"] + } + ], + "deprecated": false + } + }, + "/formbuilder/forms/export": { + "post": { + "summary": "Export Form", + "description": "Export a single Form", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.exportForm", + "responses": { + "200": { + "description": "Exported Form", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/formbuilder_formDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["FormBuilder.admin", "FormBuilder.apiread"], + "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiread"], + "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/formbuilder_formDocument_uuidv4" + }, + "name": { + "$ref": "#/components/schemas/formbuilder_formDocument_formName" + } + }, + "anyOf": [ + { + "required": ["_id"] + }, + { + "required": ["name"] + } + ], + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/formbuilder/forms/import": { + "post": { + "summary": "Import Form", + "description": "Import a single Form", + "tags": ["formbuilder"], + "parameters": [], + "operationId": "FormBuilder.importForm", + "responses": { + "200": { + "description": "Import status", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], + "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "form": { + "$ref": "#/components/schemas/formbuilder_formDocument" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "adapterMap": { + "type": "object" + } + } + } + } + } + } + } + } + } + }, + "/search/find": { + "post": { + "summary": "Search IAP", + "description": "Search through IAP for results from various collections that match your search term, as well as for results that have tags that match your search term.", + "tags": ["search"], + "parameters": [], + "operationId": "Search.find", + "responses": { + "200": { + "description": "Search results", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/search_searchResults" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Search.admin", "Search.apiwrite"], + "CookieAuth": ["Search.admin", "Search.apiwrite"], + "BasicAuth": ["Search.admin", "Search.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "text": { + "type": "string", + "examples": ["test"] + }, + "limit": { + "type": "integer", + "examples": [20] + }, + "skip": { + "type": "integer", + "examples": [5] + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/devices": { + "post": { + "summary": "Find Devices", + "description": "Gets a specific subset of devices for based on given options", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDevicesFiltered", + "responses": { + "200": { + "description": "Filtered/Sorted Devices", + "content": { + "application/json": { + "schema": { + "title": "devices", + "type": "object", + "properties": { + "entity": { + "const": "device" + }, + "total": { + "type": "integer", + "minimum": 0 + }, + "unique_device_count": { + "type": "integer", + "minimum": 0 + }, + "return_count": { + "type": "integer", + "minimum": 0 + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceDetails" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "start": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "limit": { + "type": "integer", + "minimum": 1, + "examples": [20] + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "address": { + "type": "string", + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "examples": ["10.1.98.234"] + }, + "port": { + "type": "string", + "pattern": "^[0-9]+$", + "examples": ["22"] + } + } + }, + "sort": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "enum": [-1, 1] + }, + "address": { + "enum": [-1, 1] + }, + "port": { + "enum": [-1, 1] + } + } + } + }, + "order": { + "type": "string", + "enum": ["ascending", "descending"] + }, + "adapterType": { + "type": "array", + "items": { + "type": "string", + "examples": ["NSO", "AnsibleManager"] + }, + "uniqueItems": true + }, + "adapterId": { + "type": "array", + "items": { + "type": "string", + "examples": ["ansible-us-east"], + "uniqueItems": true + } + }, + "exactMatch": { + "type": "boolean", + "description": "boolean that indicates if an exact result will be returned or not", + "enum": [true, false] + } + }, + "required": ["limit"] + } + } + } + } + } + } + } + }, + "/configuration_manager/cache/devices/ostype": { + "post": { + "summary": "Fetches OS Types to store into the cache.", + "description": "Gathers all the device OS Types in the current evnironment and stores them in the cache.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.cacheOSTypes", + "responses": { + "200": { + "description": "Cached OS Type data.", + "content": { + "application/json": { + "schema": { + "title": "cacheData", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "interval": { + "type": "integer", + "description": "Determines how often (in hours) the OS Types are cached.", + "examples": [48] + } + } + } + } + } + } + } + } + }, + "get": { + "summary": "Fetches the OSTypes stored in the cache.", + "description": "Gathers all the device OS Types in the current cache.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getCachedOSTypes", + "responses": { + "200": { + "description": "Cached OS Type data.", + "content": { + "application/json": { + "schema": { + "title": "cacheData", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Deletes the cache for os types.", + "description": "Removes the cache in the database for os type values.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteOSTypeCache", + "responses": { + "200": { + "description": "Deletion response.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "string", + "examples": [ + "Successfully deleted the cache for device os types." + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/pins": { + "delete": { + "summary": "Deletes pinned items.", + "description": "Deletes the pinned items permanently from the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deletePins", + "responses": { + "200": { + "description": "Result of the deletion.", + "content": { + "application/json": { + "schema": { + "title": "result", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pinTargets": { + "title": "pinTargets", + "type": "array", + "items": {} + }, + "sourceItem": { + "title": "sourceItem", + "type": "string" + } + } + } + } + } + } + }, + "post": { + "summary": "Add an item to pins or remove from if it already exists", + "description": "Add an item to pins or remove from if it already exists", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.handlePin", + "responses": { + "200": { + "description": "Pin object with details.", + "content": { + "application/json": { + "schema": { + "title": "pin", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "properties": { + "sourceItem": { + "type": "string", + "example": "cm_device_groups" + }, + "target": { + "type": "string", + "example": "CSR_Devices_Group" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/pins/fetch": { + "post": { + "summary": "Get a list of pinned items.", + "description": "Fetches a list of pinned items based on the input parameters. The list of pinned items are specific to the current user or actor. This api supports pagination.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getPins", + "responses": { + "200": { + "description": "Returns the list of pins and the total count.", + "content": { + "application/json": { + "schema": { + "title": "pins", + "type": "object", + "properties": { + "pins": { + "type": "array", + "items": { + "type": "object" + } + }, + "count": { + "type": "number", + "example": "10" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "properties": { + "filter": { + "type": "object", + "example": "{ sourceItem: 'cm_gc' }" + }, + "start": { + "type": "number", + "example": "0" + }, + "limit": { + "type": "number", + "example": "10" + }, + "projection": { + "type": "object", + "example": "{ users: 0 }" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/ismaintenance": { + "get": { + "summary": "Checks if the current version of CM is maintenance or not.", + "description": "Returns a boolean reflecting whether the current Configuration Manager bundle is a maintenance bundle.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.isMaintenance", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/jinja2": { + "post": { + "summary": "Renders a jinja2 template.", + "description": "Takes a jinja2 template a renders output text.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.renderJinja2", + "responses": { + "200": { + "description": "Returns the list of pins and the total count.", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "string", + "examples": ["this is a jinja2 template"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "title": "template", + "type": "string", + "example": "this is a {{ varName }} template" + }, + "variables": { + "title": "variables", + "properties": {} + }, + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/adaptertasks/search": { + "post": { + "summary": "Get data for all adapters with tasks.", + "description": "Fetch method/task metadata for all adapters that have it.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getAdapterTasks", + "responses": { + "200": { + "description": "Output of adapters' metadata.", + "content": { + "application/json": { + "schema": { + "title": "adapterData", + "type": "object", + "properties": { + "adapterTasks": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/adaptertasks": { + "post": { + "summary": "Get data for a specific adapter task.", + "description": "Fetch method/task metadata for an adapter task.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getAdapterTask", + "responses": { + "200": { + "description": "Output of adapter task's metadata.", + "content": { + "application/json": { + "schema": { + "title": "taskData", + "type": "object", + "properties": { + "adapterTasks": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskName": { + "title": "taskName", + "type": "string", + "examples": ["getConfig", "getServiceModel"] + }, + "origin": { + "title": "origin", + "type": "string", + "examples": ["nso52", "localAAA"] + }, + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/instance": { + "post": { + "summary": "Create a task instance.", + "description": "Create an instance of a task and save it to the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createTaskInstance", + "responses": { + "200": { + "description": "Response of whether the insertion operation failed or succeeded.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "instanceName": { + "title": "instanceName", + "type": "string" + }, + "origin": { + "title": "origin", + "type": "string", + "examples": ["nso52", "localAAA"] + }, + "taskName": { + "title": "taskName", + "type": "string", + "examples": ["getConfig", "getServiceModel"] + }, + "treeId": { + "title": "treeId", + "type": "string", + "examples": ["5f21c92ba6abf82bf5041783"] + }, + "taskParams": { + "title": "taskParams", + "properties": {} + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + }, + "put": { + "summary": "Update a task instance.", + "description": "Update an instance of a task and save it to the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateTaskInstance", + "responses": { + "200": { + "description": "Response of whether the update operation failed or succeeded.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskId": { + "title": "taskId", + "type": "string" + }, + "treeId": { + "title": "treeId", + "type": "string" + }, + "taskParams": { + "title": "taskParams", + "type": "object", + "properties": {} + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete task instance(s).", + "description": "Delete task instance(s) from the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteTaskInstances", + "responses": { + "200": { + "description": "Response of whether the delete operation failed or succeeded.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskIds": { + "title": "taskIds", + "type": "array", + "properties": {}, + "items": {} + }, + "treeId": { + "title": "treeId", + "type": "string" + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/instances": { + "post": { + "summary": "Get task instance(s).", + "description": "Get instance(s) of a task.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getTaskInstances", + "responses": { + "200": { + "description": "Response of whether the get operation failed or succeded (with data).", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "title": "treeId", + "type": "string", + "examples": ["5f21c92ba6abf82bf5041783"] + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "filter": { + "type": "object", + "example": "{ 'instanceName': 'some task instance 1' }" + }, + "nodePath": { + "type": "string", + "example": "base" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/instances/search": { + "post": { + "summary": "Search for task instance(s).", + "description": "Search for task instance(s) using varies options parameters.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchTaskInstances", + "responses": { + "200": { + "description": "Response of whether the get operation failed or succeded (with data).", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "filter": { + "type": "object", + "example": "{ 'instanceName': 'some task instance 1' }" + }, + "nodePath": { + "type": "string", + "example": "base" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/instance/run": { + "post": { + "summary": "Run a task instance.", + "description": "Run an instance of a task and save it to the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runTaskInstance", + "responses": { + "200": { + "description": "Data returned by the execution of the task instance..", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskId": { + "title": "taskId", + "type": "string" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/tasks/run": { + "post": { + "summary": "Run an adapter task.", + "description": "Run an adapter task.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runAdapterTask", + "responses": { + "200": { + "description": "Data returned by the exection of the adapter task.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "origin": { + "title": "origin", + "type": "string" + }, + "taskName": { + "title": "taskName", + "type": "string" + }, + "args": { + "title": "args", + "type": "object", + "properties": {} + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/{name}": { + "get": { + "summary": "Get Device Details", + "description": "Get detailed information for a specific device, based on its device name", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.getDevice", + "responses": { + "200": { + "description": "Device's details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceDetails" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/devices/{name}/configuration": { + "get": { + "summary": "Get Device Configuration", + "description": "Get configuration for a specific device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.getDeviceConfig", + "responses": { + "200": { + "description": "Configuration for a specific device", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/devices/{name}/configuration/{format}": { + "get": { + "summary": "Get formatted device config", + "description": "Get device configuration in a given format.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + { + "name": "format", + "in": "path", + "description": "Supported formats by NSO (xml, native, json) & Automation Gateway (native).", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfigurationFormat" + } + } + ], + "operationId": "ConfigurationManager.getDeviceConfigFormat", + "responses": { + "200": { + "description": "Configuration for a specific device", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": true + } + }, + "/configuration_manager/devices/backups": { + "post": { + "summary": "Backup device configuration", + "description": "Backup device configuration in mongo", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.backUpDevice", + "responses": { + "200": { + "description": "Status of backup operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "Device {deviceName} backed up successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backupDescription" + }, + "notes": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backupNotes" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/import/backups": { + "post": { + "summary": "Import backup documents", + "description": "Insert backup documents into the ucm_configs collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importBackup", + "responses": { + "200": { + "description": "Status of backup import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 device backups imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "backups": { + "title": "backups", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backup" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/import/groups": { + "post": { + "summary": "Import device group documents", + "description": "Insert device group documents into the device_groups collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importGroup", + "responses": { + "200": { + "description": "Status of group import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 device groups imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "title": "groups", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_groupDetails" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/backups": { + "post": { + "summary": "Get Device Backup List", + "description": "Fetches backups, requires an options payload. An empty option payload will return the first 25 documents", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getBackups", + "responses": { + "200": { + "description": "List of all backups and the total", + "content": { + "application/json": { + "schema": { + "title": "backups", + "type": "object", + "properties": { + "total": { + "type": "integer", + "minimum": 0 + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backup" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "start": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "limit": { + "type": "integer", + "minimum": 1, + "examples": [20] + }, + "regex": { + "type": "boolean" + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "dateRange": { + "type": "array", + "description": "An array containing the start and end date. Index 0 = start date, index 1 = end date.", + "items": {} + }, + "sort": { + "type": "object", + "properties": { + "name": { + "enum": [-1, 1] + }, + "date": { + "enum": [-1, 1] + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete one or more device backups by Id", + "description": "This API call will delete device backups based on given Ids", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDeviceBackups", + "responses": { + "200": { + "description": "Status with the number of device backups deleted", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "deleted": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "backupIds": { + "title": "backupIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/backups/list": { + "get": { + "summary": "Gets a list of all backed up devices", + "description": "Returns a list of devices that have one or more backups", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getBackedUpDevices", + "responses": { + "200": { + "description": "List of devices with backups", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/backups/{id}": { + "get": { + "summary": "Get Device Backup", + "description": "Retrieves single backup document by id", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Backup's id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getDeviceBackupById", + "responses": { + "200": { + "description": "JSON object that contains the backed up configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backup" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update a device backup by Id", + "description": "This API call will update the metadata of a device backup by ID", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Backup Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateDeviceBackupById", + "responses": { + "200": { + "description": "Status of the device backup updated", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "updated": { + "type": "integer", + "enum": [0, 1] + } + }, + "required": ["status", "updated"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backupDescription" + }, + "notes": { + "$ref": "#/components/schemas/configuration_manager_deviceData_backupNotes" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/name/devicegroups": { + "get": { + "summary": "Get Device Group by Name", + "description": "Retrieves a single group document by name", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDeviceGroupByName", + "responses": { + "200": { + "description": "JSON object that contains the device group details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupName": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + } + } + } + } + } + } + } + }, + "/configuration_manager/groups/device/{deviceName}": { + "get": { + "summary": "Gets device groups for a device", + "description": "Finds all the device groups that contain the specified device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.getGroupsForDevice", + "responses": { + "200": { + "description": "List of device groups found", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/devices/{name}/isAlive": { + "get": { + "summary": "Check if device is connected", + "description": "Get connection status of device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.isAlive", + "responses": { + "200": { + "description": "Status of device connection", + "content": { + "application/json": { + "schema": { + "title": "status", + "oneOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/devicegroup": { + "post": { + "summary": "Creates a device group", + "description": "Creates a new device group in pronghorn", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createDeviceGroup", + "responses": { + "200": { + "description": "Result of creating a new device group", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_createGroupResponseWithName" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupName": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + }, + "groupDescription": { + "$ref": "#/components/schemas/configuration_manager_common_standardDescription" + }, + "deviceNames": { + "$ref": "#/components/schemas/configuration_manager_common_multiElementString" + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups": { + "get": { + "summary": "Get all Device Groups", + "description": "Gets a list of all known device groups", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDeviceGroups", + "responses": { + "200": { + "description": "List of device groups found", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Delete device groups", + "description": "Delete specified device groups", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDeviceGroups", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_deleteGroupResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupIds": { + "title": "groupIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/search": { + "post": { + "summary": "Search all Device Groups", + "description": "Gets a list of all device groups that match the search criteria", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchDeviceGroups", + "responses": { + "200": { + "description": "List of device groups that match the search criteria", + "content": { + "application/json": { + "schema": { + "title": "deviceGroups", + "type": "object", + "properties": { + "totalCount": { + "type": "number" + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "s": { + "title": "s", + "type": "string" + }, + "start": { + "title": "start", + "type": "number" + }, + "limit": { + "title": "limit", + "type": "number" + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/query": { + "post": { + "summary": "Search device groups", + "description": "Returns device groups that match the specified input", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchGroups", + "responses": { + "200": { + "description": "List of device groups that match the search criteria", + "content": { + "application/json": { + "schema": { + "title": "deviceGroups", + "type": "object", + "properties": { + "totalCount": { + "type": "number" + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "start": { + "title": "start", + "type": "number" + }, + "limit": { + "title": "limit", + "type": "number" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "regex": { + "type": "boolean", + "description": "Enables global regex/substring search." + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/{id}": { + "get": { + "summary": "Get Device Group by ID", + "description": "Get Device Group by ID", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Group Id or Group Name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getDeviceGroupById", + "responses": { + "200": { + "description": "JSON object that contains the device group details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update device groups", + "description": "Updates the device group's details and devices.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Group Id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateDeviceGroups", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "details": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupDetails" + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/{id}/devices": { + "delete": { + "summary": "Removes devices from a group", + "description": "Removes devices from a device group", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "ConfigurationManager.removeDevicesFromGroup", + "responses": { + "200": { + "description": "Result of removing devices", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "devices": { + "title": "devices", + "type": "array", + "properties": {}, + "items": {} + } + } + } + } + } + } + }, + "post": { + "summary": "Adds new devices to the group", + "description": "Adds devices to a group", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "ConfigurationManager.addDevicesToGroup", + "responses": { + "200": { + "description": "Result of adding new devices to the group", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "devices": { + "title": "devices", + "type": "array", + "properties": {}, + "items": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/name/deviceGroups": { + "delete": { + "summary": "Delete device groups", + "description": "Delete specified device groups", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDeviceGroupsByName", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_deleteGroupResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupNames": { + "title": "groupNames", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/deviceGroups/devices": { + "post": { + "summary": "Add device(s) to a group", + "description": "This API call will add device(s) to a device group", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.addDevicesToGroupByName", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupName": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + }, + "deviceNames": { + "$ref": "#/components/schemas/configuration_manager_common_multiElementString" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete device(s) from a group", + "description": "This API call will delete device(s) from a device group", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDevicesFromGroup", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupName": { + "$ref": "#/components/schemas/configuration_manager_common_standardName" + }, + "deviceNames": { + "$ref": "#/components/schemas/configuration_manager_common_multiElementString" + } + } + } + } + } + } + } + }, + "/configuration_manager/lookup_diff": { + "put": { + "summary": "Diff two strings from a lookup.", + "description": "Lookup two strings and return a diff.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.lookupDiff", + "responses": { + "200": { + "description": "diffResult", + "content": { + "application/json": { + "schema": { + "title": "diffResult", + "type": "array", + "items": { + "type": "array" + }, + "examples": [ + [ + [-1, "version 16.12"], + [1, "Building configuration..."], + [0, "service timestamps debug datetime"], + [-1, "msec"], + [0, "localtime"] + ] + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "nextId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "collection": { + "title": "collection", + "type": "string", + "minLength": 1 + }, + "nextCollection": { + "title": "nextCollection", + "type": "string", + "minLength": 1 + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "type": { + "type": "boolean" + }, + "clean": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configurations/parser": { + "post": { + "summary": "Create a config parser.", + "description": "Create rules for a parser for breaking down configs in GC.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createConfigParser", + "responses": { + "200": { + "description": "data", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "minLength": 1 + }, + "lexRules": { + "title": "lexRules", + "items": { + "title": "lexRule", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + ["^{", "open_statement_block"], + ["^}", "close_statement_block"] + ] + } + }, + "template": { + "title": "template", + "type": "string", + "enum": ["cisco-ios", "f5-bigip"] + } + } + } + } + } + } + }, + "put": { + "summary": "Update a config parser.", + "description": "Update rules for a parser for breaking down configs in GC.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateConfigParser", + "responses": { + "200": { + "description": "result", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "updated": { + "type": "number" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "minLength": 1 + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "lexRules": { + "type": "array", + "items": { + "title": "ruleDefinitions", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + ["^{", "open_statemen_block"], + ["^}", "close_statemen_block"] + ] + } + }, + "template": { + "type": "string", + "examples": ["cisco-ios"] + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a config parser.", + "description": "Permanently delete a configuration parser.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteConfigParser", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "minLength": 1 + }, + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + }, + "get": { + "summary": "Get all config parsers.", + "description": "Gets a list of all known config parsers.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "start", + "in": "query", + "description": "start", + "required": false, + "schema": { + "type": "integer", + "minimum": 0, + "examples": [0] + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "examples": [20] + } + }, + { + "name": "regex", + "in": "query", + "description": "regex", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "filter", + "in": "query", + "description": "filter", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "integer", + "enum": [-1, 1] + }, + "date": { + "type": "integer", + "enum": [-1, 1] + } + } + } + } + ], + "operationId": "ConfigurationManager.getConfigParsers", + "responses": { + "200": { + "description": "List of config parsers found", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "array", + "items": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/configurations/parser/search": { + "post": { + "summary": "Get a config parser.", + "description": "Get a defined Config Parser from the database.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getConfigParser", + "responses": { + "200": { + "description": "data", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": { + "parser": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filter": { + "title": "filter", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/configurations/parsers": { + "delete": { + "summary": "Delete one or more config parsers by Id", + "description": "This API call will delete config parsers based on given Ids", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteConfigParsers", + "responses": { + "200": { + "description": "Status with the number of config parsers deleted", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "deleted": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "parserIds": { + "title": "parserIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/import/parsers": { + "post": { + "summary": "Import parser documents", + "description": "Insert parser documents into the ucm_configs collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importParsers", + "responses": { + "200": { + "description": "Status of parser import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 device parsers imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "parsers": { + "title": "parsers", + "type": "array", + "items": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/configs": { + "get": { + "summary": "Get a list of all Golden Config trees.", + "description": "Get a list of all Golden Config trees.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getGoldenConfigTrees", + "responses": { + "200": { + "description": "List of all Golden Config trees", + "content": { + "application/json": { + "schema": { + "title": "goldenConfigTrees", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Adds a new Golden Config tree", + "description": "Adds a new Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createGoldenConfigTree", + "responses": { + "200": { + "description": "details of the initial version of the newly created tree", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": [ + "Cisco Edge - Day 0", + "Cisco Edge - Day 1", + "Cisco Core - Day 0", + "Cisco Core - Day 1" + ] + }, + "deviceType": { + "title": "deviceType", + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete one or more golden configuration trees by tree id", + "description": "This API call will delete golden configuration trees based on given tree ids", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteGoldenConfigTrees", + "responses": { + "200": { + "description": "Status with the number of golden configurations deleted", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "deleted": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeIds": { + "title": "treeIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/{treeId}": { + "get": { + "summary": "Get summary of a Golden Config tree.", + "description": "Get summary of the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getGoldenConfigTree", + "responses": { + "200": { + "description": "Requested Golden Config tree", + "content": { + "application/json": { + "schema": { + "title": "tree", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Adds a new Golden Config tree", + "description": "Adds a new Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "ID of the new Golden Config tree", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.createGoldenConfigTreeVersion", + "responses": { + "200": { + "description": "details of the initial version of the newly created tree", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "base": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + } + } + } + } + }, + "put": { + "summary": "Updates properties of a Golden Config tree", + "description": "Updates properties of the specified Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateGoldenConfigTree", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config tree updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["GC Tree Name"] + }, + "gbac": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a Golden Config tree.", + "description": "Deletes the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.deleteGoldenConfigTree", + "responses": { + "200": { + "description": "Result of the delete request", + "content": { + "application/json": { + "schema": { + "title": "deleteResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config tree deleted"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/configs/{treeId}/{version}": { + "get": { + "summary": "Get details of a Golden Config tree version.", + "description": "Get a detailed view of the specified Golden Config tree version.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + ], + "operationId": "ConfigurationManager.getGoldenConfigTreeVersion", + "responses": { + "200": { + "description": "Requested Golden Config tree version", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates properties of a Golden Config tree version", + "description": "Updates properties of the specified Golden Config tree version", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + ], + "operationId": "ConfigurationManager.updateGoldenConfigTreeVersion", + "responses": { + "200": { + "description": "status of creation and the new tree, if successful", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Configuration tree version updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["updated version name"] + }, + "variables": { + "title": "variables", + "type": "object", + "properties": {} + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a Golden Config tree.", + "description": "Deletes the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + ], + "operationId": "ConfigurationManager.deleteGoldenConfigTreeVersion", + "responses": { + "200": { + "description": "Result of the delete request", + "content": { + "application/json": { + "schema": { + "title": "deleteResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Configuration tree version deleted"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/search/configs": { + "post": { + "summary": "Get summary of a Golden Config tree.", + "description": "Get summary of the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchGoldenConfigTrees", + "responses": { + "200": { + "description": "List of all Golden Config trees", + "content": { + "application/json": { + "schema": { + "title": "goldenConfigTrees", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "properties": { + "start": { + "type": "number", + "example": "0" + }, + "limit": { + "type": "number", + "example": "10" + }, + "sort": { + "type": "number", + "example": 1 + }, + "deviceType": { + "type": "string", + "example": "cisco-ios" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/device/trees": { + "post": { + "summary": "Find trees which contain the specified device.", + "description": "Search through all GC Trees to find all locations where a device exists.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getTreesForDevice", + "responses": { + "200": { + "description": "List of trees that the device belongs to.", + "content": { + "application/json": { + "schema": { + "title": "trees", + "type": "array", + "items": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/tree": { + "post": { + "summary": "Fetches all the devices that exist on a tree.", + "description": "Search through a GC Tree to find all the devices that exist on it.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDevicesOnTree", + "responses": { + "200": { + "description": "Response containing the list of devices.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "nodes": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/variables/{treeId}/{version}": { + "delete": { + "summary": "Deletes one or more variables", + "description": "Verifies and deletes the requested deletion variables", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + } + ], + "operationId": "ConfigurationManager.deleteVariables", + "responses": { + "200": { + "description": "status of the variables to delete", + "content": { + "application/json": { + "schema": { + "title": "deleteResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Deletion successful."] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "variables": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigVariables" + } + } + } + } + } + } + } + }, + "/configuration_manager/configurations/rules": { + "put": { + "summary": "Updates the config rule set of a JSON Golden Config tree version", + "description": "Updates the config rule set of a JSON Golden Config tree version", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateJSONConfigRules", + "responses": { + "200": { + "description": "status of the rule set update.", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Rule Set successfully updated."] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "ruleSet": { + "title": "ruleSet", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/devices/groups": { + "delete": { + "summary": "Remove Device Groups from Node", + "description": "Remove device groups from a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.removeGroupsFromNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "deviceGroups": { + "title": "deviceGroups", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Add Device Groups to Node", + "description": "Add device groups to a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.addGroupsToNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "deviceGroups": { + "title": "deviceGroups", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/export/goldenconfigs": { + "post": { + "summary": "Export a Golden Config tree.", + "description": "Exports the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.exportGoldenConfigTree", + "responses": { + "200": { + "description": "Dereferenced golden config tree", + "content": { + "application/json": { + "schema": { + "title": "exportResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "data": { + "type": "array", + "title": "data", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + }, + "/configuration_manager/import/goldenconfigs": { + "post": { + "summary": "Import golden config tree documents", + "description": "Insert golden config documents into the golden config collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importGoldenConfigTree", + "responses": { + "200": { + "description": "Status of golden config import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 golden config trees imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "trees": { + "title": "trees", + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "array", + "description": "Documents of given tree per version", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" + } + } + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/node/tasks": { + "delete": { + "summary": "Remove Tasks from Node", + "description": "Remove Tasks from a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.removeTasksFromNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "tasks": { + "title": "tasks", + "type": "array", + "items": { + "type": "string", + "title": "taskId", + "examples": ["5f9700486aa2ad95d85fc973"] + } + } + } + } + } + } + } + }, + "post": { + "summary": "Add Tasks to Node", + "description": "Add Tasks to a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.addTasksToNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "tasks": { + "title": "tasks", + "type": "array", + "items": { + "type": "string", + "title": "taskId", + "examples": ["5f9700486aa2ad95d85fc973"] + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/{treeId}/{version}/{nodePath(*)}/devices": { + "post": { + "summary": "Add Devices to Node", + "description": "Add devices to a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.addDevicesToNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "devices": { + "title": "devices", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove Devices from Node", + "description": "Remove devices from a node in a Golden Config tree", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.removeDevicesFromNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "devices": { + "title": "devices", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/{treeId}/{version}/{parentNodePath(*)}": { + "post": { + "summary": "Create a new node in a Golden Config tree.", + "description": "Create a new node in the specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "parentNodePath", + "in": "path", + "description": "parentNodePath", + "required": true, + "schema": { + "title": "parentNodePath", + "type": "string", + "examples": ["base/US East"] + } + } + ], + "operationId": "ConfigurationManager.createGoldenConfigNode", + "responses": { + "200": { + "description": "Newly created node", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNode" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["DC"] + } + } + } + } + } + } + } + }, + "/configuration_manager/configs/{treeId}/{version}/{nodePath(*)}": { + "put": { + "summary": "Update properties of a node in a Golden Config tree.", + "description": "Update properties of the specified Golden Config node.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.updateGoldenConfigNode", + "responses": { + "200": { + "description": "updateNodeResult", + "content": { + "application/json": { + "schema": { + "title": "updateNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Golden Config node updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["Southeast"] + }, + "attributes": { + "title": "attributes", + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "configId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a node in a Golden Config tree.", + "description": "Permanently delete the specified node in the Golden Config tree. Not reversible.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.deleteGoldenConfigNode", + "responses": { + "200": { + "description": "deleteNodeResult", + "content": { + "application/json": { + "schema": { + "title": "deleteNodeResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Configuration node deleted"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/config_specs/{id}": { + "get": { + "summary": "Get a Config Spec document.", + "description": "Get the details of the specified Config Spec.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getConfigSpec", + "responses": { + "200": { + "description": "configSpec", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpec" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update a Config Spec.", + "description": "Update content of the Config Spec.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateConfigSpec", + "responses": { + "200": { + "description": "configSpecUpdateResult", + "content": { + "application/json": { + "schema": { + "title": "configSpecUpdateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Config Spec updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "template": { + "type": "string", + "examples": ["ntp server {{ ipAddress }}"] + }, + "variables": { + "type": "string", + "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/config_template": { + "post": { + "summary": "Get a Config Spec template.", + "description": "Get the template of the specified Config Spec", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getConfigTemplate", + "responses": { + "200": { + "description": "template", + "content": { + "application/json": { + "schema": { + "title": "template", + "type": "object", + "properties": { + "currentTemplate": { + "type": "string" + }, + "inheritedTemplate": { + "type": "string" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/config_specs": { + "post": { + "summary": "Create a new Config Spec.", + "description": "Create a new Config Spec.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createConfigSpec", + "responses": { + "200": { + "description": "configSpec", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpec" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceType": { + "title": "deviceType", + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "data": { + "title": "data", + "type": "object", + "properties": { + "template": { + "type": "string", + "examples": ["ntp server {{ ipAddress }}"] + }, + "variables": { + "type": "string", + "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/node/config": { + "put": { + "summary": "Update node configuration.", + "description": "Updates the configuration for a specified node.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateNodeConfig", + "responses": { + "200": { + "description": "nodeUpdateResult", + "content": { + "application/json": { + "schema": { + "title": "nodeUpdateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Node Config updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "treeVersion": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "data": { + "title": "data", + "type": "object", + "properties": { + "template": { + "type": "string", + "examples": ["ntp server {{ ipAddress }}"] + }, + "variables": { + "type": "string", + "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] + } + } + }, + "updateVariables": { + "title": "updateVariables", + "type": "boolean" + } + } + } + } + } + } + } + }, + "/configuration_manager/translate/config_spec": { + "post": { + "summary": "Convert a config spec into a readable string.", + "description": "Converts a object like config into a human-readable config string.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.translateConfigSpec", + "responses": { + "200": { + "description": "configData", + "content": { + "application/json": { + "schema": { + "title": "configData", + "type": "object", + "properties": { + "config": { + "type": "string", + "examples": [ + "interface Loopback01\n description loopback01" + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeID": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/generate/config_spec": { + "post": { + "summary": "Builds a config spec from raw config.", + "description": "Takes raw native config and builds a configuration spec.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.buildSpecLines", + "responses": { + "200": { + "description": "specLines", + "content": { + "application/json": { + "schema": { + "title": "specLines", + "type": "array", + "properties": {}, + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecLine" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nativeConfig": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfigurationString" + }, + "deviceType": { + "title": "deviceType", + "type": "string", + "enum": [ + "cisco-ios", + "cisco-asa", + "cisco-ios-xr", + "cisco-nx", + "cisco-staros", + "alu-sr", + "a10-acos", + "juniper-junos", + "f5-bigip", + "arista-eos" + ] + }, + "options": { + "title": "options", + "properties": {}, + "type": "object" + } + } + } + } + } + } + } + }, + "/configuration_manager/json_specs/{id}": { + "get": { + "summary": "Get a JSON Spec document.", + "description": "Get the details of the specified JSON Spec.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getJSONSpec", + "responses": { + "200": { + "description": "JSONSpec", + "content": { + "application/json": { + "schema": { + "title": "JSONSpec", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Update a JSON Spec", + "description": "Update content of the JSON Spec.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.updateJSONSpec", + "responses": { + "200": { + "description": "jsonSpecUpdateResult", + "content": { + "application/json": { + "schema": { + "title": "jsonSpecUpdateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["JSON Spec updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/json_specs": { + "post": { + "summary": "Get a JSON Spec document with inheritance.", + "description": "Get the details of the specified JSON Spec with inheritance.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getJSONSpecWithInheritance", + "responses": { + "200": { + "description": "JSONSpec", + "content": { + "application/json": { + "schema": { + "title": "JSONSpec", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "options": { + "title": "options", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/json_specs/create": { + "post": { + "summary": "Create a new JSON Spec.", + "description": "Create a new JSON Spec.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createJSONSpec", + "responses": { + "200": { + "description": "jsonSpec", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigJSONSpec" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/config": { + "post": { + "summary": "Run Compliance Reports.", + "description": "Kick off one or more compliance checks for devices in a specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runConfigCompliance", + "responses": { + "200": { + "description": "runComplianceBatchResult", + "content": { + "application/json": { + "schema": { + "title": "runComplianceBatchResult", + "type": "object", + "properties": { + "status": { + "type": "integer", + "const": 202 + }, + "message": { + "type": "string", + "examples": ["compliance batch ${batchId} started"] + }, + "batchId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceName": { + "title": "deviceName", + "type": "string", + "examples": ["Cisco-Device.1"] + }, + "configuration": { + "title": "configuration", + "type": "string", + "examples": [ + "interface Loopback1\n ip address 10.0.0.1\nntp server 105.62.30.158" + ] + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports": { + "post": { + "summary": "Run Compliance Reports.", + "description": "Kick off one or more compliance checks for devices in a specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runCompliance", + "responses": { + "200": { + "description": "runComplianceBatchResult", + "content": { + "application/json": { + "schema": { + "title": "runComplianceBatchResult", + "type": "object", + "properties": { + "status": { + "type": "integer", + "const": 202 + }, + "message": { + "type": "string", + "examples": ["compliance batch ${batchId} started"] + }, + "batchId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "tasks": { + "type": "array", + "items": { + "type": "string" + }, + "examples": ["5f7b4c5ab2f4e0690520eed2"] + }, + "variables": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigVariables" + }, + "bidirectional": { + "type": "boolean" + } + }, + "required": ["treeId", "version"] + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/backups": { + "post": { + "summary": "Run Compliance Reports on Backups.", + "description": "Kick off one or more compliance checks for backups in a specified Golden Config tree.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runComplianceOnBackups", + "responses": { + "200": { + "description": "runComplianceBatchResult", + "content": { + "application/json": { + "schema": { + "title": "runComplianceBatchResult", + "type": "object", + "properties": { + "status": { + "type": "integer", + "const": 202 + }, + "message": { + "type": "string", + "examples": ["compliance batch ${batchId} started"] + }, + "batchId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeInfo": { + "title": "treeInfo", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + } + }, + "required": ["treeId", "version", "nodePath"] + }, + "backupIds": { + "title": "backupIds", + "type": "array", + "items": { + "type": "string", + "title": "backupId", + "examples": ["5f9700486aa2ad95d85fc973"] + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "bidirectional": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/tree/{treeId}": { + "get": { + "summary": "Summarize Compliance Reports for a Tree.", + "description": "Summarize Compliance Reports for a Tree.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getComplianceReportTreeSummary", + "responses": { + "200": { + "description": "complianceSummary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceSummary" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/compliance_reports/node/{treeId}/{nodePath(*)}": { + "get": { + "summary": "Summarize Compliance Reports for a Node.", + "description": "Summarize Compliance Reports for a Node.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "treeId", + "in": "path", + "description": "treeId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + { + "name": "nodePath", + "in": "path", + "description": "nodePath", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + ], + "operationId": "ConfigurationManager.getComplianceReportNodeSummary", + "responses": { + "200": { + "description": "complianceSummary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceSummary" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/compliance_reports/grade": { + "post": { + "summary": "Get graded compliance reports for a node.", + "description": "Get a set of graded and scored compliance reports for a node.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.gradeComplianceReports", + "responses": { + "200": { + "description": "graded_compliance_reports", + "content": { + "application/json": { + "schema": { + "title": "graded_compliance_reports", + "type": "array", + "items": { + "type": "object", + "properties": { + "grade": { + "type": "string", + "examples": ["pass", "review", "fail"] + }, + "total": { + "type": "integer", + "minimum": 0 + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "records": { + "type": "array", + "items": { + "type": "object", + "properties": { + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "reportId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "timestamp": { + "$ref": "#/components/schemas/configuration_manager_common_timestamp" + }, + "score": { + "type": "number" + }, + "grade": { + "type": "string", + "examples": ["pass", "review", "fail"] + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "options": { + "title": "options", + "allOf": [ + { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_reportGradingOptions" + }, + { + "type": "object", + "properties": { + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + } + ] + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/grade/single": { + "post": { + "summary": "Grade Report", + "description": "Get graded compliance report", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.gradeComplianceReport", + "responses": { + "200": { + "description": "graded_compliance_report", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportGraded" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reportId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_reportGradingOptions" + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/grade/history": { + "post": { + "summary": "Get historical graded compliance reports.", + "description": "Get historical graded compliance reports for a device on a node.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.gradeDeviceComplianceHistory", + "responses": { + "200": { + "description": "graded_compliance_history", + "content": { + "application/json": { + "schema": { + "title": "graded_compliance_history", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "options": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" + } + } + } + } + } + } + } + }, + "/configuration_manager/json_compliance_reports/grade/history": { + "post": { + "summary": "Get historical graded compliance reports.", + "description": "Get historical graded compliance reports for a task instance on a node.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.gradeTaskComplianceHistory", + "responses": { + "200": { + "description": "graded_compliance_history", + "content": { + "application/json": { + "schema": { + "title": "graded_compliance_history", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "taskId": { + "title": "taskId", + "type": "string", + "examples": ["5f80bd24f8479975bb46054d"] + }, + "options": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/query/history": { + "post": { + "summary": "Get historical graded compliance reports with pagination support.", + "description": "Get historical graded compliance reports for a device on a node with pagination support.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.queryGradedComplianceHistory", + "responses": { + "200": { + "description": "graded_compliance_history", + "content": { + "application/json": { + "schema": { + "title": "graded_compliance_history", + "properties": { + "total": { + "title": "total", + "type": "number" + }, + "history": { + "title": "history", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + }, + "filter": { + "title": "filter", + "properties": { + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "taskId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + }, + "options": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/batch/{batchId}": { + "get": { + "summary": "Get compliance report metadata for a batch.", + "description": "Get compliance report metadata by batch ID.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "batchId", + "in": "path", + "description": "batchId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getComplianceReportsByBatch", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/json_compliance_reports/batch/{batchId}": { + "get": { + "summary": "Get compliance report metadata for a batch.", + "description": "Get compliance report metadata by batch ID.", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "batchId", + "in": "path", + "description": "batchId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getJSONComplianceReportsByBatch", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/compliance_reports/history": { + "post": { + "summary": "Compliance Reports totals for a Device.", + "description": "Compliance Reports totals for a Device.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getComplianceReportDeviceHistory", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "limit": { + "type": "integer", + "minimum": 1 + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/history/backups": { + "post": { + "summary": "Compliance Reports totals for a Backup.", + "description": "Compliance Reports totals for a Backup.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getComplianceReportBackupHistory", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "backups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "limit": { + "type": "integer", + "minimum": 1 + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/json_compliance_reports/history": { + "post": { + "summary": "Compliance Reports totals for a Task Instance.", + "description": "Compliance Reports totals for a Task Instance.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getComplianceReportTaskHistory", + "responses": { + "200": { + "description": "complianceHistory", + "content": { + "application/json": { + "schema": { + "title": "complianceHistory", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "taskIds": { + "type": "array", + "items": { + "type": "string", + "title": "taskIds", + "examples": ["5f1063d78cf3b62347de4b87"] + } + }, + "limit": { + "type": "integer", + "minimum": 1 + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/details/{reportId}": { + "get": { + "summary": "Get Compliance Report", + "description": "Get the details of a particular compliance report", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "reportId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getComplianceReportDetail", + "responses": { + "200": { + "description": "complianceReportDetail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/json_compliance_reports/details/{reportId}": { + "get": { + "summary": "Get JSON Compliance Report", + "description": "Get the details of a particular JSON compliance report", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "reportId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getJSONComplianceReportDetail", + "responses": { + "200": { + "description": "complianceReportDetail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/compliance_reports/details": { + "post": { + "summary": "Get details of a particular set of compliance checks.", + "description": "Get details of a particular set of compliance checks.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getComplianceReportsDetail", + "responses": { + "200": { + "description": "complianceReportsDetail", + "content": { + "application/json": { + "schema": { + "title": "complianceReportsDetail", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reportIds": { + "title": "reportIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_reports/topissues": { + "post": { + "summary": "Get the top issues from compliance reports", + "description": "Get the top most offending issues from all latest compliance reports", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getTopIssues", + "responses": { + "200": { + "description": "topIssuesResults", + "content": { + "application/json": { + "schema": { + "title": "topIssuesResults", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecLineId" + }, + "specWords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecWord" + } + }, + "count": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/json_compliance_reports/topissues": { + "post": { + "summary": "Get the top issues from JSON compliance reports", + "description": "Get the top most offending issues from all latest JSON compliance reports", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getTopIssuesJson", + "responses": { + "200": { + "description": "topIssuesResults", + "content": { + "application/json": { + "schema": { + "title": "topIssuesResults", + "type": "array", + "items": { + "type": "object", + "properties": {} + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "treeId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "version": { + "type": "string", + "examples": ["v3"] + }, + "nodePath": { + "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/patch_device/{deviceName}": { + "post": { + "summary": "Alters a device configuration", + "description": "Apply specified changes to a device configuration", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "deviceName", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.patchDeviceConfiguration", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "patchResult", + "type": "object", + "properties": { + "response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "boolean" + }, + "parents": { + "type": "array", + "items": { + "type": "string" + } + }, + "new": { + "type": "string" + }, + "old": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "changes": { + "title": "changes", + "type": "array", + "items": { + "type": "object", + "properties": { + "parents": { + "type": "array", + "items": { + "type": "string", + "examples": ["parent line of config"] + } + }, + "old": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["old config line", null] + }, + "new": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["new config line", null] + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/patch_device/advanced/{deviceName}": { + "post": { + "summary": "Alters a device configuration", + "description": "Apply specified changes to a device configuration with additional options", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "deviceName", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.advancedPatchDeviceConfiguration", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "patchResult", + "type": "object", + "properties": { + "response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "boolean" + }, + "parents": { + "type": "array", + "items": { + "type": "string" + } + }, + "new": { + "type": "string" + }, + "old": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "changes": { + "title": "changes", + "type": "array", + "items": { + "type": "object", + "properties": { + "parents": { + "type": "array", + "items": { + "type": "string", + "examples": ["parent line of config"] + } + }, + "old": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["old config line", null] + }, + "new": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["new config line", null] + } + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "backupDevice": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/changes/convert": { + "post": { + "summary": "Converts patch data to native config.", + "description": "Converts the config patch data into a readable native config.", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.convertChangesToConfig", + "responses": { + "200": { + "description": "configData", + "content": { + "application/json": { + "schema": { + "title": "configData", + "type": "object", + "properties": { + "config": { + "type": "string", + "examples": [ + "interface Loopback01\n description loopback01" + ] + }, + "changes": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceType": { + "title": "deviceType", + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "changes": { + "title": "changes", + "type": "array", + "items": { + "type": "object", + "properties": { + "parents": { + "type": "array", + "items": { + "type": "string", + "examples": ["parent line of config"] + } + }, + "old": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["old config line", null] + }, + "new": { + "anyOf": [ + { + "const": null + }, + { + "type": "string" + } + ], + "examples": ["new config line", null] + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/actions/{device&:origin&:action}": { + "get": { + "summary": "Call Adapter Method", + "description": "Perform south bound specific logic via direct adapter call(s)", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "device", + "in": "path", + "description": "device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + { + "name": "origin", + "in": "path", + "description": "origin name", + "required": true, + "schema": { + "title": "origin", + "type": "string", + "examples": ["nso46", "ansible-us"] + } + }, + { + "name": "action", + "in": "path", + "description": "adapter action/function to be called", + "required": true, + "schema": { + "title": "action", + "type": "string", + "examples": ["checkSync"] + } + } + ], + "operationId": "ConfigurationManager.adapterProxy", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "adapterResponse", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/templates": { + "post": { + "summary": "Creates a device template", + "description": "Creates a new device template in pronghorn", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createDeviceTemplate", + "responses": { + "200": { + "description": "Result of creating a new device template", + "content": { + "application/json": { + "schema": { + "title": "data", + "properties": { + "result": { + "type": "string", + "example": "success" + }, + "data": { + "type": "object", + "example": { + "id": "610315295595a5fcb99f8ce2", + "name": "Cisco Login Banner", + "template": "banner login {{ bannerBody }}", + "variables": { + "bannerBody": "Welcome to this Cisco Device." + }, + "created": "2021-07-29T20:52:57.378Z", + "updated": "2021-07-29T20:52:57.378Z", + "createdBy": "5eaaf3796b16027c8aeb612a", + "updatedBy": "5eaaf3796b16027c8aeb612a", + "gbac": { + "write": [], + "read": [] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "template": { + "title": "template", + "type": "string", + "examples": [ + "interface Loopback1\n description {{ description }}" + ] + }, + "variables": { + "title": "variables", + "type": "object", + "properties": {} + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "deviceOSTypes": { + "type": "array" + } + } + } + } + } + } + } + } + }, + "put": { + "summary": "Updates a device template", + "description": "Updates a new device template in pronghorn", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateDeviceTemplate", + "responses": { + "200": { + "description": "Result of creating a new device template", + "content": { + "application/json": { + "schema": { + "title": "data", + "properties": { + "status": { + "type": "string", + "example": "success" + }, + "updated": { + "type": "number", + "example": 2 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "data": { + "title": "data", + "properties": { + "template": { + "type": "string", + "example": "ntp server {{ ipAddress }}" + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + }, + "name": { + "type": "string", + "example": "NTP Server Template" + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "deviceOSTypes": { + "type": "array" + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete one or more device template(s) by Id", + "description": "This API call will delete device templates based on given Ids", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteDeviceTemplates", + "responses": { + "200": { + "description": "Status with the number of device templates deleted", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "conflict"] + }, + "deleted": { + "type": "integer", + "minimum": 0 + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "templateIds": { + "title": "templateIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/templates/search": { + "post": { + "summary": "Gets a device template", + "description": "Gets a new device template in pronghorn", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.getDeviceTemplates", + "responses": { + "200": { + "description": "Result of creating a new device template", + "content": { + "application/json": { + "schema": { + "title": "data", + "properties": { + "total": { + "type": "number", + "example": 1 + }, + "list": { + "type": "object", + "example": [ + { + "id": "610315295595a5fcb99f8ce2", + "name": "Cisco Login Banner", + "template": "banner login {{ bannerBody }}", + "variables": { + "bannerBody": "Welcome to this Cisco Device." + }, + "created": "2021-07-29T20:52:57.378Z", + "updated": "2021-07-29T20:52:57.378Z", + "createdBy": "5eaaf3796b16027c8aeb612a", + "updatedBy": "5eaaf3796b16027c8aeb612a", + "gbac": { + "write": [], + "read": [] + } + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/import/templates": { + "post": { + "summary": "Import device config template documents", + "description": "Insert device config template documents into the device_templates collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importDeviceTemplates", + "responses": { + "200": { + "description": "Status of template import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 device template imported successfully" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "templates": { + "title": "templates", + "type": "array", + "items": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/{deviceName}/configuration": { + "post": { + "summary": "Apply a device config", + "description": "This API call will apply a configuration to a specified device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.applyDeviceConfig", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/templates/apply": { + "post": { + "summary": "Apply a device config template", + "description": "This API call will apply a configuration template to a specified device", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.applyDeviceTemplate", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deviceName": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + }, + "templateId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/devices/{deviceName}/operationaldata": { + "post": { + "summary": "Get operational data for a device", + "description": "Gets all the operational data for the specified device", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + } + ], + "operationId": "ConfigurationManager.getOperationalData", + "responses": { + "200": { + "description": "Direct reponse from the origin's adapter", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "properties": { + "filter": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/import/plans": { + "post": { + "summary": "Import compliance plan documents", + "description": "Insert compliance plan documents into the ucm_compliance_plans collection", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.importCompliancePlan", + "responses": { + "200": { + "description": "Status of compliance plan import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 compliance plan(s) imported successfully." + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "plans": { + "title": "plans", + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "description": "The ID of the compliance plan." + }, + "name": { + "type": "string", + "description": "The name of the compliance plan to import" + }, + "description": { + "type": "string", + "description": "The description of the compliance plan to import" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "treeId": { + "type": "string", + "description": "The treeId of the GC that the node belongs to." + }, + "version": { + "type": "string", + "description": "The version of the GC tree that the node belongs to." + }, + "nodeId": { + "type": "string", + "description": "The configId of the node." + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + } + } + } + }, + "gbac": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plans": { + "post": { + "summary": "Creates a compliance plan", + "description": "Creates a compliance plan which can be used to execute compliance reports", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.createCompliancePlan", + "responses": { + "200": { + "description": "Details of the newly created compliance plan", + "content": { + "application/json": { + "schema": { + "title": "compliancePlan", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["Firewall Policies"] + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the compliance plan.", + "examples": ["A compliance plan for firewall configs."] + }, + "nodes": { + "type": "array", + "description": "Nodes to add into the compliance plan.", + "items": { + "type": "object", + "properties": { + "treeId": { + "type": "string", + "description": "The treeId of the GC that the node belongs to." + }, + "version": { + "type": "string", + "description": "The version of the GC tree that the node belongs to." + }, + "nodeId": { + "type": "string", + "description": "The configId of the node." + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "deviceGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "tasks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "put": { + "summary": "Updates a compliance plan", + "description": "Updates a compliance plan that already exists", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateCompliancePlan", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Compliance Plan updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the compliance plan.", + "examples": ["A compliance plan for firewall configs."] + }, + "name": { + "type": "string", + "description": "New name for the Compliance Plan", + "examples": ["Firewall Policies"] + }, + "nodes": { + "type": "array", + "description": "Nodes to add into the compliance plan.", + "items": { + "type": "object", + "properties": { + "treeId": { + "type": "string", + "description": "The treeId of the GC that the node belongs to." + }, + "version": { + "type": "string", + "description": "The version of the GC tree that the node belongs to." + }, + "nodeId": { + "type": "string", + "description": "The configId of the node." + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "deviceGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "tasks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + }, + "gbac": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["63696917c49ecc7b03b5f02b"] + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete compliance plans", + "description": "Delete the specified compliance plans", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.deleteCompliancePlans", + "responses": { + "200": { + "description": "Status of update operation", + "content": { + "application/json": { + "schema": { + "title": "deleteResult", + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "deleted": { + "type": "number" + } + }, + "required": ["status", "deleted"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planIds": { + "title": "planIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plans/{planId}": { + "get": { + "summary": "Fetches a compliance plan", + "description": "Fetches a compliance plan with the provided ID", + "tags": ["configuration_manager"], + "parameters": [ + { + "name": "planId", + "in": "path", + "description": "planId", + "required": true, + "schema": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + ], + "operationId": "ConfigurationManager.getCompliancePlan", + "responses": { + "200": { + "description": "Requested Golden Config tree version", + "content": { + "application/json": { + "schema": { + "title": "compliancePlan", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false + } + }, + "/configuration_manager/search/compliance_plans": { + "post": { + "summary": "Search all Compliance Plans", + "description": "Gets a list of all Compliance Plans that match the search criteria", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchCompliancePlans", + "responses": { + "200": { + "description": "List of Compliance Plans that match the search criteria", + "content": { + "application/json": { + "schema": { + "title": "compliancePlans", + "type": "object", + "properties": { + "totalCount": { + "type": "number" + }, + "groups": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "start": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "limit": { + "type": "integer", + "minimum": 1, + "examples": [20] + }, + "sort": { + "type": "number", + "example": 1 + } + }, + "required": ["start", "limit"] + } + } + } + } + } + } + } + }, + "/configuration_manager/search/compliance_plan_instances": { + "post": { + "summary": "Search all Compliance Plan instances", + "description": "Gets a list of all Compliance Plan Instances that match the search criteria", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.searchCompliancePlanInstances", + "responses": { + "200": { + "description": "List of Compliance Plan Instances that match the search criteria", + "content": { + "application/json": { + "schema": { + "title": "compliancePlanInstances", + "type": "object", + "properties": { + "totalCount": { + "type": "number" + }, + "groups": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "searchParams": { + "title": "searchParams", + "type": "object", + "properties": { + "instanceId": { + "type": "string", + "description": "ID of the instance to fetch" + }, + "planId": { + "type": "string", + "description": "Fetches all instances with this planId" + }, + "planName": { + "type": "string", + "description": "Fetches all instances with this planName" + }, + "description": { + "type": "string", + "description": "Filter by description of the plan instance.", + "example": ["A description for my compliance plan."] + }, + "status": { + "type": "string", + "description": "Filter by status of the Job pertainig to the plan instance.", + "enum": [ + "running", + "complete", + "paused", + "error", + "canceled" + ] + }, + "dateRange": { + "type": "array", + "description": "An array containing the start and end date. Index 0 = start date, index 1 = end date.", + "items": {} + }, + "start": { + "type": "integer", + "minimum": 0, + "examples": [0] + }, + "limit": { + "type": "integer", + "minimum": 1, + "examples": [20] + }, + "sort": { + "type": "object", + "properties": { + "started": { + "enum": [-1, 1] + }, + "jobStatus": { + "enum": [-1, 1] + }, + "name": { + "enum": [-1, 1] + } + } + } + }, + "oneOf": [ + { + "required": ["instanceId"] + }, + { + "required": ["planId"] + }, + { + "required": ["planName"] + } + ] + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plans/nodes": { + "post": { + "summary": "Adds node(s) to a compliance plan", + "description": "Adds new node(s) to an already existing compliance plan", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.addNodesToCompliancePlan", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": [ + "Successfully added node(s) to compliance plan" + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "nodes": { + "title": "nodes", + "type": "array", + "items": { + "type": "object", + "properties": { + "treeId": { + "type": "string", + "description": "The treeId of the GC that the node belongs to." + }, + "version": { + "type": "string", + "description": "The version of the GC tree that the node belongs to." + }, + "nodeId": { + "type": "string", + "description": "The configId of the node." + }, + "variables": { + "type": "object", + "example": "{ \"ipAddress\": \"1.2.3.4\" }" + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" + } + }, + "deviceGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "tasks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + } + } + } + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + }, + "delete": { + "summary": "Removes node(s) from a compliance plan", + "description": "Removes new node(s) from an already existing compliance plan", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.removeNodesFromCompliancePlan", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": [ + "Successfully added node(s) to compliance plan" + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "nodeIds": { + "title": "nodeIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + } + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plans/run": { + "post": { + "summary": "Runs a compliance plan", + "description": "This API call will create WF job that will execute the compliance plan", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.runCompliancePlan", + "responses": { + "200": { + "description": "The details of the plan instance that was created.", + "content": { + "application/json": { + "schema": { + "title": "response", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "type": "object", + "properties": {} + } + } + } + } + } + } + } + }, + "/configuration_manager/compliance_plan_instances": { + "put": { + "summary": "Update properties of a compliance plan instance", + "description": "Update properties of the specified compliance plan instance", + "tags": ["configuration_manager"], + "parameters": [], + "operationId": "ConfigurationManager.updateCompliancePlanInstance", + "responses": { + "200": { + "description": "updateResult", + "content": { + "application/json": { + "schema": { + "title": "updateResult", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "examples": ["Compliance Run Report updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "CookieAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ], + "BasicAuth": [ + "ConfigurationManager.admin", + "ConfigurationManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "planId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "instanceId": { + "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "type": "string", + "examples": ["Compliance plan instance description"] + } + } + } + } + } + } + } + } + } + }, + "/automation-studio/templates": { + "get": { + "summary": "Gets a page of template documents.", + "description": "Gets a page of template documents.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + } + }, + { + "name": "exclude-project-members", + "in": "query", + "description": "Flag which removes workflows from the results which are members of a project", + "required": false, + "schema": { + "type": "boolean", + "description": "Flag which removes workflows from the results which are members of a project" + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "in", + "in": "query", + "description": "Search for fields exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "not-in", + "in": "query", + "description": "Search for fields not exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "equals", + "in": "query", + "description": "Returns results where the specified fields exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string" + } + }, + { + "name": "contains", + "in": "query", + "description": "Returns results where the specified fields contain the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields contain the given match string(s).", + "type": "string" + } + }, + { + "name": "starts-with", + "in": "query", + "description": "Returns results where the specified fields start with the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string" + } + }, + { + "name": "ends-with", + "in": "query", + "description": "Returns results where the specified fields end in the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.getTemplates", + "responses": { + "200": { + "description": "Results for the given search parameters.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_template" + } + }, + "total": { + "type": "integer", + "description": "Total number of documents matching the given query parameters." + }, + "start": { + "type": "integer", + "description": "Search index of first document in the items array." + }, + "end": { + "type": "integer", + "description": "Search index of the last document in the items array." + }, + "count": { + "type": "integer", + "description": "Length of the items array." + }, + "next": { + "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "previous": { + "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Creates a new template document.", + "description": "Creates a new template document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.createTemplate", + "responses": { + "200": { + "description": "Created template and associated edit URI.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "description": "Created template and associated edit URI.", + "properties": { + "created": { + "$ref": "#/components/schemas/automation-studio_template" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the newly created template." + } + }, + "required": ["created", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "$ref": "#/components/schemas/automation-studio_template" + } + } + } + } + } + } + } + }, + "/automation-studio/templates/{id}": { + "get": { + "summary": "Gets a single template document.", + "description": "Gets a single template document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ObjectId specifying a template entity.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "ObjectId specifying a template entity." + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + } + ], + "operationId": "AutomationStudio.getTemplate", + "responses": { + "200": { + "description": "Transformed data.", + "content": { + "application/json": { + "schema": { + "title": "output", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Deletes a template document.", + "description": "Deletes a template document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Template id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Template id." + } + } + ], + "operationId": "AutomationStudio.deleteTemplate", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Message denoting the status of the delete operation." + } + }, + "required": ["message"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Replaces a template document.", + "description": "Replaces a template document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Template id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Template id." + } + } + ], + "operationId": "AutomationStudio.updateTemplate", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "updated": { + "$ref": "#/components/schemas/automation-studio_template" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the updated template." + } + }, + "required": ["updated", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "update": { + "$ref": "#/components/schemas/automation-studio_templateUpdate" + } + } + } + } + } + } + } + }, + "/automation-studio/templates/import": { + "post": { + "summary": "Imports a new template document.", + "description": "Imports a new template document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.importTemplates", + "responses": { + "200": { + "description": "Results from each individual import operation.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "imported": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Status flag denoting the success (true) or failure (false) of the template's import operation." + }, + "message": { + "type": "string", + "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." + }, + "original": { + "$ref": "#/components/schemas/automation-studio_templateImport" + }, + "created": { + "description": "The imported template as it exists after being imported.", + "oneOf": [ + { + "$ref": "#/components/schemas/automation-studio_template" + }, + { + "type": "null" + } + ] + }, + "edit": { + "description": "URI to the edit page for the imported template.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "message", + "original", + "created", + "edit" + ] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "templates": { + "title": "templates", + "description": "Array of template documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a template's name is already used in the templates collection, it will be renamed with a numeric suffix.", + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_templateImport" + } + } + } + } + } + } + } + } + }, + "/automation-studio/templates/{id}/export": { + "get": { + "summary": "Exports a template document.", + "description": "Exports a template document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Template id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Template id." + } + } + ], + "operationId": "AutomationStudio.exportTemplate", + "responses": { + "200": { + "description": "Exported representation of the template.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_templateImport" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/json-forms/method-options": { + "get": { + "summary": "Get all available rest calls in IAP.", + "description": "Get all available rest calls in IAP.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.getMethodOptions", + "responses": { + "200": { + "description": "List of all rest calls available in the system.", + "content": { + "application/json": { + "schema": { + "title": "calls", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "getTemplate", + "createTemplate", + "importTemplates", + "exportTemplate" + ] + }, + "sourceType": { + "type": "string", + "examples": [ + "AutomationStudio", + "ConfigurationManager", + "MOP" + ] + }, + "path": { + "type": "string", + "examples": [ + "/templates/:id", + "/createTemplate", + "/listAnalyticTemplates" + ] + }, + "verb": { + "type": "string", + "enum": ["GET", "POST"] + }, + "origin": { + "type": "string", + "examples": [ + "/automation-studio", + "/mop", + "/validate-form/:id" + ] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AutomationStudio.admin"], + "CookieAuth": ["AutomationStudio.admin"], + "BasicAuth": ["AutomationStudio.admin"] + } + ], + "deprecated": false + } + }, + "/automation-studio/apps/list": { + "get": { + "summary": "Get a list of all the apps and adapters", + "description": "Get all apps and adapters.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.getAppsAndAdapters", + "responses": { + "200": { + "description": "List of all apps and adapters.", + "content": { + "application/json": { + "schema": { + "title": "apps_list", + "type": "array", + "items": { + "type": "object", + "examples": [ + { + "id": "@itential/app-admin_essentials", + "type": "UI", + "name": "AdminEssentials" + }, + { + "id": "@itential/app-automation_studio", + "type": "Application", + "name": "AutomationStudio" + }, + { + "id": "@itential/app-configuration_manager", + "type": "Application", + "name": "ConfigurationManager" + }, + { + "id": "@itential/app-ag_manager", + "type": "Application", + "name": "AGManager" + }, + { + "id": "@itential/app-form_builder", + "type": "Application", + "name": "FormBuilder" + } + ] + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/workflows": { + "get": { + "summary": "Gets a page of workflow documents.", + "description": "Gets a page of workflow documents.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + } + }, + { + "name": "exclude-project-members", + "in": "query", + "description": "Flag which removes workflows from the results which are members of a project", + "required": false, + "schema": { + "type": "boolean", + "description": "Flag which removes workflows from the results which are members of a project" + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "expand", + "in": "query", + "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", + "required": false, + "schema": { + "type": "string", + "title": "List of fields to get expanded data", + "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", + "examples": ["created_by,user,owner"] + } + }, + { + "name": "in", + "in": "query", + "description": "Search for fields exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string", + "examples": [ + "in[name]=my-workflow,or-this-workflow&in[type]=automation" + ] + } + }, + { + "name": "not-in", + "in": "query", + "description": "Search for fields not exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string", + "examples": ["not-in[name]=my-workflow,not-this-workflow"] + } + }, + { + "name": "equals", + "in": "query", + "description": "Returns results where the specified fields exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string", + "examples": ["equals[name]=my-workflow"] + } + }, + { + "name": "contains", + "in": "query", + "description": "Returns results where the specified fields contain the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields contain the given match string(s).", + "type": "string", + "examples": ["contains[name]=workflow"] + } + }, + { + "name": "starts-with", + "in": "query", + "description": "Returns results where the specified fields start with the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string", + "examples": ["starts-with[name]=my-"] + } + }, + { + "name": "ends-with", + "in": "query", + "description": "Returns results where the specified fields end in the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string", + "examples": ["ends-with[name]=-workflow"] + } + }, + { + "name": "task-equals", + "in": "query", + "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", + "type": "string", + "examples": ["task-equals[app]=WorkFlowEngine"] + } + } + ], + "operationId": "AutomationStudio.getWorkflows", + "responses": { + "200": { + "description": "Results for the given search parameters.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_workflowDocument" + } + }, + "total": { + "type": "integer", + "description": "Total number of documents matching the given query parameters." + }, + "start": { + "type": "integer", + "description": "Search index of first document in the items array." + }, + "end": { + "type": "integer", + "description": "Search index of the last document in the items array." + }, + "count": { + "type": "integer", + "description": "Length of the items array." + }, + "limit": { + "type": "integer", + "description": "Number of results to return. Used for pagination." + }, + "next": { + "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "previous": { + "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/workflows/detailed/{name}": { + "get": { + "summary": "Get Details of a Workflow", + "description": "Get the details of a Workflow by Workflow name.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow to get Workflow details.", + "required": true, + "schema": { + "type": "string", + "title": "name" + } + } + ], + "operationId": "AutomationStudio.getWorkflowDetailedByName", + "responses": { + "200": { + "description": "Workflow details matching the Workflow name.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_workflowDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/automations": { + "post": { + "summary": "Creates a new workflow document.", + "description": "Creates a new workflow document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.createAutomation", + "responses": { + "200": { + "description": "Created workflow and associated edit URI.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "description": "Created workflow and associated edit URI.", + "properties": { + "created": { + "$ref": "#/components/schemas/automation-studio_automation" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the newly created workflow." + } + }, + "required": ["created", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "automation": { + "$ref": "#/components/schemas/automation-studio_automation" + } + } + } + } + } + } + } + }, + "/automation-studio/automations/{id}": { + "put": { + "summary": "Replaces a workflow document.", + "description": "Replaces a workflow document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Workflow id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Workflow id." + } + } + ], + "operationId": "AutomationStudio.updateAutomation", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "updated": { + "$ref": "#/components/schemas/automation-studio_automation" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the updated workflow." + } + }, + "required": ["updated", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "update": { + "$ref": "#/components/schemas/automation-studio_automationUpdate" + } + } + } + } + } + } + } + }, + "/automation-studio/automations/import": { + "post": { + "summary": "Imports a new workflow document.", + "description": "Imports a new workflow document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.importAutomations", + "responses": { + "200": { + "description": "Results from each individual import operation.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "imported": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Status flag denoting the success (true) or failure (false) of the workflow's import operation." + }, + "message": { + "type": "string", + "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." + }, + "original": { + "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" + }, + "created": { + "description": "The imported workflow as it exists after being imported.", + "oneOf": [ + { + "$ref": "#/components/schemas/automation-studio_workflowDocument" + }, + { + "type": "null" + } + ] + }, + "edit": { + "description": "URI to the edit page for the imported workflow.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "message", + "original", + "created", + "edit" + ] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "automations": { + "title": "automations", + "description": "Array of workflow documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'.", + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" + } + } + } + } + } + } + } + } + }, + "/automation-studio/component-groups": { + "get": { + "summary": "Gets a page of component group documents.", + "description": "Gets a page of component group documents.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "in", + "in": "query", + "description": "Search for fields exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "not-in", + "in": "query", + "description": "Search for fields not exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "equals", + "in": "query", + "description": "Returns results where the specified fields exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string" + } + }, + { + "name": "contains", + "in": "query", + "description": "Returns results where the specified fields contain the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields contain the given match string(s).", + "type": "string" + } + }, + { + "name": "starts-with", + "in": "query", + "description": "Returns results where the specified fields start with the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string" + } + }, + { + "name": "ends-with", + "in": "query", + "description": "Returns results where the specified fields end in the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.getComponentGroups", + "responses": { + "200": { + "description": "Results for the given search parameters.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_componentGroup" + } + }, + "total": { + "type": "integer", + "description": "Total number of documents matching the given query parameters.", + "examples": [100] + }, + "start": { + "type": "integer", + "description": "Search index of first document in the items array.", + "examples": [0] + }, + "end": { + "type": "integer", + "description": "Search index of the last document in the items array.", + "examples": [100] + }, + "count": { + "type": "integer", + "description": "Length of the items array.", + "examples": [100] + }, + "next": { + "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "previous": { + "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Creates a new component group document.", + "description": "Creates a new component group document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.createComponentGroup", + "responses": { + "200": { + "description": "Created component group and associated edit URI.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "description": "Created component group and associated edit URI.", + "properties": { + "created": { + "$ref": "#/components/schemas/automation-studio_componentGroup" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the newly created component group." + } + }, + "required": ["created", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "componentGroup": { + "$ref": "#/components/schemas/automation-studio_componentGroup" + } + } + } + } + } + } + } + }, + "/automation-studio/component-groups/{id}": { + "get": { + "summary": "Gets a single component group document.", + "description": "Gets a single component group document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ObjectId specifying a component group entity.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "ObjectId specifying a component group entity." + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + } + ], + "operationId": "AutomationStudio.getComponentGroup", + "responses": { + "200": { + "description": "Transformed data.", + "content": { + "application/json": { + "schema": { + "title": "output", + "type": "object", + "examples": [ + { + "_id": "67d863a07620432ed58f7964", + "name": "Automation Studio", + "description": "", + "gbacRead": [], + "gbacWrite": [], + "members": [ + { + "path": ["addComponentsToProject"], + "ref": "2c27f941-aa37-42b2-9ecf-d0398676745d", + "sourceCollection": "workflows", + "type": "component", + "name": "addComponentsToProject" + }, + { + "path": ["createProject"], + "ref": "887d1e2d-3641-41f4-9f93-40bc0f134b5b", + "sourceCollection": "workflows", + "type": "component", + "name": "createProject" + } + ] + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.readonly", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Deletes a component group document.", + "description": "Deletes a component group document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Component group id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Component group id." + } + } + ], + "operationId": "AutomationStudio.deleteComponentGroup", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Message denoting the status of the delete operation.", + "examples": [ + "Deleted componentGroup 67d32e60a402649caa29a006" + ] + } + }, + "required": ["message"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Replaces a component group document.", + "description": "Replaces a component group document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Component group id.", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Component group id." + } + } + ], + "operationId": "AutomationStudio.updateComponentGroup", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "updated": { + "$ref": "#/components/schemas/automation-studio_componentGroup" + }, + "edit": { + "type": "string", + "description": "URI to the edit page for the updated component group." + } + }, + "required": ["updated", "edit"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "update": { + "$ref": "#/components/schemas/automation-studio_componentGroupUpdate" + } + } + } + } + } + } + } + }, + "/automation-studio/component-groups/import": { + "post": { + "summary": "Imports a new component group document.", + "description": "Imports a new component group document.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.importComponentGroups", + "responses": { + "200": { + "description": "Results from each individual import operation.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "imported": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "description": "Status flag denoting the success (true) or failure (false) of the component group's import operation." + }, + "message": { + "type": "string", + "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." + }, + "original": { + "$ref": "#/components/schemas/automation-studio_componentGroupImport" + }, + "created": { + "description": "The imported component group as it exists after being imported.", + "oneOf": [ + { + "$ref": "#/components/schemas/automation-studio_componentGroup" + }, + { + "type": "null" + } + ] + }, + "edit": { + "description": "URI to the edit page for the imported component group.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "message", + "original", + "created", + "edit" + ] + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "componentGroups": { + "title": "componentGroups", + "description": "Array of component group documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a component group's name is already used in the component groups collection, it will be renamed with a numeric suffix.", + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_componentGroupImport" + } + } + } + } + } + } + } + } + }, + "/automation-studio/workflows/validate": { + "post": { + "summary": "Validate a workflow", + "description": "Validate a workflow, and return the resulting errors and warnings arrays.", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.validateWorkflow", + "responses": { + "200": { + "description": "Errors and warnings output from the validation process", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "validationResult", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "object" + } + }, + "warnings": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread", + "AutomationStudio.apiwrite" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread", + "AutomationStudio.apiwrite" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.engineering", + "AutomationStudio.support", + "AutomationStudio.apiread", + "AutomationStudio.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" + } + } + } + } + } + } + } + }, + "/automation-studio/references-to": { + "get": { + "summary": "Gets references to a particular document.", + "description": "Gets references to a particular document.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "target-type", + "in": "query", + "description": "Type of document to search for references to.", + "required": false, + "schema": { + "type": "string", + "description": "Type of document to search for references to." + } + }, + { + "name": "target-identifiers", + "in": "query", + "description": "IDs of the components to search for references to.", + "required": false, + "schema": { + "type": "string", + "description": "IDs of the components to search for references to." + } + }, + { + "name": "referrer-type", + "in": "query", + "description": "Type of documents to search for references in.", + "required": false, + "schema": { + "type": "string", + "description": "Type of documents to search for references in." + } + } + ], + "operationId": "AutomationStudio.getReferencesTo", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "referencesByTarget": { + "type": "array", + "items": { + "type": "object", + "properties": { + "target": { + "type": "object", + "properties": { + "identifer": { + "type": "string", + "examples": [ + "940a1b4f-399a-44df-a42e-d37da51c7637", + "5eb596edf955d0e5288f84ef" + ] + }, + "type": { + "type": "string", + "enum": [ + "workflow", + "json-form", + "transformation", + "template", + "command-template", + "analytic-template", + "form" + ] + } + } + }, + "totalReferencingInstances": { + "type": "number" + }, + "totalReferences": { + "type": "number" + }, + "references": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "workflow", + "json-form", + "transformation", + "template", + "command-template", + "analytic-template", + "form" + ] + }, + "_id": { + "type": "string", + "examples": [ + "940a1b4f-399a-44df-a42e-d37da51c7637", + "5eb596edf955d0e5288f84ef" + ] + }, + "name": { + "type": "string" + }, + "referencePaths": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer" + ] + } + ], + "deprecated": true + } + }, + "/automation-studio/locations/{location}/packages/{pckg}/tasks/{method}": { + "get": { + "summary": "Get Task Details", + "description": "Get the detailed information model for a task", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "location", + "in": "path", + "description": "Location: Application, Broker, Adapter", + "required": true, + "schema": { + "type": "string", + "title": "location" + } + }, + { + "name": "pckg", + "in": "path", + "description": "Package name", + "required": true, + "schema": { + "type": "string", + "title": "pckg", + "examples": ["WorkFlowEngine"] + } + }, + { + "name": "method", + "in": "path", + "description": "Method name", + "required": true, + "schema": { + "type": "string", + "title": "method", + "examples": ["query", "merge"] + } + } + ], + "operationId": "AutomationStudio.getTaskDetails", + "responses": { + "200": { + "description": "Detailed information on a task", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_taskDetails" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] + } + ], + "deprecated": false + } + }, + "/automation-studio/multipleTaskDetails": { + "post": { + "summary": "Get Task Details", + "description": "Get the detailed information model for a task", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.getMultipleTaskDetails", + "responses": { + "200": { + "description": "Detailed information on a task", + "content": { + "application/json": { + "schema": { + "type": "array", + "title": "taskDetails", + "items": { + "$ref": "#/components/schemas/automation-studio_taskDetails" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "inputsArray": { + "type": "array", + "title": "inputsArray", + "items": { + "type": "object", + "properties": { + "location": { + "title": "location", + "type": "string", + "description": "Location: Application, Broker, Adapter", + "examples": ["Application", "Adapter", "Broker"] + }, + "pckg": { + "title": "pckg", + "type": "string", + "description": "Package name", + "examples": ["WorkFlowEngine"] + }, + "method": { + "title": "method", + "type": "string", + "description": "Method name", + "examples": ["query", "merge"] + } + } + } + } + } + } + } + } + } + } + }, + "/automation-studio/projects": { + "get": { + "summary": "Search projects", + "description": "Search projects", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.getProjects", + "responses": { + "200": { + "description": "Projects", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully retrieved projects"] + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + }, + "metadata": { + "type": "object", + "properties": { + "skip": { + "type": "number" + }, + "limit": { + "type": "number" + }, + "total": { + "type": "number" + }, + "previousPageSkip": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "number" + } + ] + }, + "nextPageSkip": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "number" + } + ] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] + } + ], + "deprecated": false + }, + "post": { + "summary": "Creates a new project", + "description": "Creates a new project", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.createProject", + "responses": { + "200": { + "description": "Create result", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully created project"] + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "createData", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_projects-create-data" + } + } + } + } + } + }, + "/automation-studio/projects/{projectId}": { + "get": { + "summary": "Gets a single Project", + "description": "Gets a single Project", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.getProject", + "responses": { + "200": { + "description": "API response body", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully retrieved project"] + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Updates an existing project", + "description": "Updates an existing project", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier, either an ObjectId or an IID", + "required": true, + "schema": { + "$ref": "#/components/schemas/automation-studio_projects-http-id" + } + } + ], + "operationId": "AutomationStudio.updateProject", + "responses": { + "200": { + "description": "Update result", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "updateData", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_projects-update-data" + } + } + } + } + } + }, + "/automation-studio/projects/{id}/export": { + "get": { + "summary": "Exports a project document as a JSON document, inlining all related documents into its components array", + "description": "Exports a project document as a JSON document, inlining all related documents into its components array", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "title": "id", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.exportProject", + "responses": { + "200": { + "description": "Exported project", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully exported project"] + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-export-v1" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/projects/import": { + "post": { + "summary": "Imports a project document from a JSON document", + "description": "Imports a project document from a JSON document", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.importProject", + "responses": { + "200": { + "description": "Import result", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "properties": { + "project": { + "$ref": "#/components/schemas/automation-studio_projects-export-v1" + }, + "conflictMode": { + "type": "string", + "enum": ["overwrite", "insert-new"] + }, + "skipReferenceValidation": { + "type": "boolean", + "description": "If true, validations will not be run against references.", + "default": false + }, + "assignNewReferences": { + "type": "boolean", + "description": "This being true would indicate that the imported project is part of a clone action.", + "default": false + } + } + } + } + } + } + } + }, + "/automation-studio/discoverReferences": { + "post": { + "summary": "Discover referenced resources", + "description": "Finds all resource references from a set of specified resource identifiers", + "tags": ["automation-studio"], + "parameters": [], + "operationId": "AutomationStudio.discoverReferences", + "responses": { + "200": { + "description": "References", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_resource-ref-http" + } + } + } + ] + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer", + "AutomationStudio.engineering" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer", + "AutomationStudio.engineering" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread", + "AutomationStudio.designer", + "AutomationStudio.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "properties": { + "resourceIdentifiers": { + "type": "array", + "description": "Array of resource identifiers to find references for.", + "items": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of the resource." + }, + "resourcePointer": { + "type": "string", + "description": "The pointer to the identifier value in the resource object." + }, + "resourceId": { + "type": "string", + "description": "The value of the identifier in the resource object." + }, + "recursionDepth": { + "type": "integer", + "description": "Specifies the number of hierarchical levels to traverse when discovering references for this component. If omitted, the search on this component will be fully recursive." + } + } + } + }, + "recursive": { + "type": "boolean", + "description": "If true, recursively looks up resources on all referenced resources.", + "default": false + }, + "includeResources": { + "type": "boolean", + "description": "If true, include the full resource document in each resource reference object.", + "default": false + }, + "ignore": { + "type": "object", + "description": "An object of resource types to directions that will not be included in discovery. Cannot be used with include.", + "additionalProperties": { + "enum": ["up", "down", "all"] + } + }, + "include": { + "type": "object", + "description": "An object of resource types and directions to be included in discovery. Cannot be used with ignore.", + "additionalProperties": { + "enum": ["up", "down", "all"] + } + }, + "removeCycles": { + "type": "boolean", + "description": "If true, removes all cyclic relationships from the list of resource references.", + "default": false + } + } + } + } + } + } + } + }, + "/automation-studio/projects/{id}": { + "delete": { + "summary": "Delete a project and any components it contains", + "description": "Delete a project and any components it contains", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Project ID", + "required": true, + "schema": { + "title": "id", + "type": "string", + "description": "Project ID" + } + } + ], + "operationId": "AutomationStudio.deleteProject", + "responses": { + "200": { + "description": "Response object.", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Message denoting the status of the delete operation." + } + }, + "required": ["message"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false + } + }, + "/automation-studio/projects/{projectId}/components/{componentId}": { + "delete": { + "summary": "Remove a component from a project", + "description": "Remove a component from a project", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string", + "description": "Project identifier" + } + }, + { + "name": "componentId", + "in": "path", + "description": "Component identifier", + "required": true, + "schema": { + "title": "componentId", + "type": "number", + "description": "Component identifier" + } + } + ], + "operationId": "AutomationStudio.removeComponentFromProject", + "responses": { + "200": { + "description": "Response object", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Message denoting the status of the delete operation" + }, + "data": { + "$ref": "#/components/schemas/automation-studio_projects-http" + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "description": "Options designating removal mode", + "properties": { + "mode": { + "type": "string", + "enum": ["delete", "move"] + } + } + } + } + } + } + } + } + } + }, + "/automation-studio/projects/{projectId}/components/add": { + "post": { + "summary": "Add one or more components to Project", + "description": "Add one or more components to Project", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.addComponentsToProject", + "responses": { + "200": { + "description": "Updated project", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + }, + "metadata": { + "type": "object", + "properties": { + "newComponents": { + "type": "array", + "description": "Components added" + }, + "failedComponents": { + "type": "array", + "description": "Components failed to add" + }, + "idMap": { + "type": "array", + "description": "Id map for original and cloned component", + "examples": [ + [ + { + "original": "1a643151-459b-4a4a-be91-623536b65df3", + "clone": "8696f332-030b-4c2a-8b1b-95844cbb6aea" + } + ] + ] + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "required": ["components"], + "properties": { + "components": { + "$ref": "#/components/schemas/automation-studio_projects-common_components" + }, + "mode": { + "type": "string", + "enum": ["move", "copy"] + } + } + } + } + } + } + } + }, + "/automation-studio/projects/{projectId}/thumbnail": { + "put": { + "summary": "Set a project's thumbnail image", + "description": "Set a project's thumbnail image", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.uploadProjectThumbnail", + "responses": { + "200": { + "description": "Updated project", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/automation-studio_projects-http" + } + }, + "metadata": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ], + "BasicAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiwrite", + "AutomationStudio.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/automation-studio_project-thumbnails-update-data" + } + } + } + } + }, + "get": { + "summary": "Gets a Project's thumbnail", + "description": "Gets a Project's thumbnail. Returns data as a base64 encoded string of binary data.", + "tags": ["automation-studio"], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project identifier", + "required": true, + "schema": { + "title": "projectId", + "type": "string" + } + } + ], + "operationId": "AutomationStudio.getProjectThumbnail", + "responses": { + "200": { + "description": "API response body", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Successfully retrieved project thumbnail"] + }, + "data": { + "type": "object", + "properties": { + "image": { + "description": "Base64 encoded binary contents of the image file", + "type": "string", + "examples": [""] + }, + "backgroundColor": { + "description": "Hex value of thumbnail background color", + "type": "string", + "examples": ["#FFFFFF"] + }, + "metadata": { + "type": "object" + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], + "CookieAuth": [ + "AutomationStudio.admin", + "AutomationStudio.apiread" + ], + "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] + } + ], + "deprecated": false + } + }, + "/tags/get": { + "post": { + "summary": "Get tag details given an id", + "description": "Get details and results for a single tag given that tags id.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.get", + "responses": { + "200": { + "description": "Tag details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "title": "id", + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + } + } + } + } + } + } + } + }, + "/tags/find": { + "post": { + "summary": "Find tags by name", + "description": "Find a list of tags given a name.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.find", + "responses": { + "200": { + "description": "Tag details", + "content": { + "application/json": { + "schema": { + "title": "details", + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/tags/all": { + "get": { + "summary": "Get all tags", + "description": "Get a list of all tags.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.all", + "responses": { + "200": { + "description": "Get all tags", + "content": { + "application/json": { + "schema": { + "title": "details", + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false + } + }, + "/tags/create": { + "post": { + "summary": "Create new tag", + "description": "Create a new tag.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.create", + "responses": { + "200": { + "description": "New tag data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/tags_tagDocument_tagName" + }, + "description": { + "$ref": "#/components/schemas/tags_tagDocument_tagDescription" + } + } + } + } + } + } + } + } + } + }, + "/tags/createTags": { + "post": { + "summary": "Create many new tags", + "description": "Create multiple new tags at once.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.createTags", + "responses": { + "200": { + "description": "New tag data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/tags_tagDocument_tagName" + }, + "description": { + "$ref": "#/components/schemas/tags_tagDocument_tagDescription" + } + } + } + } + } + } + } + } + } + } + }, + "/tags/createReference": { + "post": { + "summary": "Reference a tag to a peice of content", + "description": "Create reference for tag that links it to a peice of content. This allows for content to find the tags related to it.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.createReference", + "responses": { + "200": { + "description": "New Reference Tag data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_referenceObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], + "CookieAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], + "BasicAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "tag_id": { + "$ref": "#/components/schemas/tags_tagDocument_tagId" + }, + "ref_id": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefId" + }, + "type": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefType" + } + } + } + } + } + } + } + } + } + }, + "/tags/handleReferences": { + "post": { + "summary": "Create/Update references for tags", + "description": "Create/Update references for multiple tags to a peice of content", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.handleReferences", + "responses": { + "200": { + "description": "If tag reference updates were successful.", + "content": { + "application/json": { + "schema": { + "title": "success", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], + "CookieAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], + "BasicAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "tag_ids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_tagId" + } + }, + "ref_id": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefId" + }, + "type": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefType" + } + } + } + } + } + } + } + } + } + }, + "/tags/getTagsByReference": { + "post": { + "summary": "Get Tags by content id", + "description": "Get tags for a piece of content by the content id", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.getTagsByReference", + "responses": { + "200": { + "description": "Array of tags related to reference id", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_referenceObject" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], + "CookieAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], + "BasicAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "ref_id": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefId" + } + } + } + } + } + } + } + } + } + }, + "/tags/getTagReferences": { + "post": { + "summary": "Get Tag refs by content ids", + "description": "Get tag references from multiple content ids.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.getTagReferences", + "responses": { + "200": { + "description": "Array of tags related to content ids", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_referenceObject" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], + "CookieAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], + "BasicAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "title": "data", + "type": "object", + "properties": { + "ref_id": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tags_tagDocument_contentRefId" + } + } + } + } + } + } + } + } + } + } + }, + "/tags/update": { + "post": { + "summary": "Updating existing tag", + "description": "Updating existing tag", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.update", + "responses": { + "200": { + "description": "Updated tag data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag": { + "type": "object", + "title": "tag", + "properties": { + "_id": { + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + }, + "description": { + "type": "string", + "examples": ["Descriptions can be empty"] + }, + "name": { + "type": "string", + "examples": ["My Tag"] + } + } + } + } + } + } + } + } + } + }, + "/tags/duplicate": { + "post": { + "summary": "Clone existing tag", + "description": "Duplicate existing tag by cloning it and changing the name.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.duplicate", + "responses": { + "200": { + "description": "Results from duplicated tag", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_id": { + "title": "_id", + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + } + } + } + } + } + } + } + }, + "/tags/delete": { + "post": { + "summary": "Delete existing tag", + "description": "Delete an existing tag.", + "tags": ["tags"], + "parameters": [], + "operationId": "Tags.delete", + "responses": { + "200": { + "description": "Results from deleted tag", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tags_tagDocument_tagObject" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "CookieAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ], + "BasicAuth": [ + "Tags.admin", + "Tags.other", + "Tags.readonly", + "Tags.apiread", + "Tags.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_id": { + "title": "_id", + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + } + } + } + } + } + } + } + }, + "/workflow_engine/activate": { + "post": { + "summary": "Activate Task Worker", + "description": "Activate Task Worker", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.activate", + "responses": { + "200": { + "description": "Status flag of activation", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/jobWorker/activate": { + "post": { + "summary": "Activate the job worker", + "description": "Allow new parent jobs to be created", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.activateJobWorker", + "responses": { + "200": { + "description": "Status flag of activation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/deactivate": { + "post": { + "summary": "Deactivate Task Worker", + "description": "Deactivate Task Worker", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.deactivate", + "responses": { + "200": { + "description": "Status flag of deactivation", + "content": { + "application/json": { + "schema": { + "title": "Status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/jobWorker/deactivate": { + "post": { + "summary": "Deactivate the job worker", + "description": "Disallow new parent jobs from being created", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.deactivateJobWorker", + "responses": { + "200": { + "description": "Status flag of deactivation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/diffToHTML": { + "post": { + "summary": "diff to HTML", + "description": "Difference between two values in HTML response", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.diffToHTML", + "responses": { + "200": { + "description": "HTML difference between value1 and value2", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "string", + "examples": ["config configuration \n 3 222 \n was is "] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "label1": { + "title": "label1", + "type": "string", + "examples": ["pre"] + }, + "value1": { + "title": "value1", + "type": "string", + "examples": [ + "config\n stuff \nline 3 \ntoday was a good day" + ] + }, + "label2": { + "title": "label2", + "type": "string", + "examples": ["post"] + }, + "value2": { + "title": "value2", + "type": "string", + "examples": [ + "configuration\n stuff \nline 222 \ntoday is a good day" + ] + } + } + } + } + } + } + } + }, + "/workflow_engine/jobs/metrics": { + "get": { + "summary": "Get aggregate job metrics", + "description": "Search aggregate job metrics with options", + "tags": ["workflow_engine"], + "parameters": [ + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_order" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_sort" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" + } + }, + { + "name": "greaterThanEquals", + "in": "query", + "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", + "required": false, + "schema": { + "type": "integer", + "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", + "examples": [1617383798468, 1617383798460] + } + }, + { + "name": "greaterThanEqualsField", + "in": "query", + "description": "Date field to compare.", + "required": false, + "schema": { + "type": "string", + "description": "Date field to compare.", + "examples": ["metrics.startDate"], + "enum": ["metrics.startDate"] + } + }, + { + "name": "contains", + "in": "query", + "description": "String value to compare with containsField.", + "required": false, + "schema": { + "type": "string", + "description": "String value to compare with containsField.", + "examples": ["exampleName"] + } + }, + { + "name": "containsField", + "in": "query", + "description": "Field to compare with contains value.", + "required": false, + "schema": { + "type": "string", + "description": "Field to compare with contains value.", + "examples": ["workflow.name"], + "enum": ["workflow.name"] + } + } + ], + "operationId": "WorkFlowEngine.getJobMetrics", + "responses": { + "200": { + "description": "metrics", + "content": { + "application/json": { + "schema": { + "title": "metrics", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow_engine_taskMetricsDocument" + } + }, + "skip": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" + }, + "limit": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" + }, + "total": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/tasks/metrics": { + "get": { + "summary": "Get aggregate task metrics", + "description": "Search aggregate task metrics with options", + "tags": ["workflow_engine"], + "parameters": [ + { + "name": "order", + "in": "query", + "description": "order", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_order" + } + }, + { + "name": "sort", + "in": "query", + "description": "sort", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_sort" + } + }, + { + "name": "skip", + "in": "query", + "description": "skip", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" + } + }, + { + "name": "limit", + "in": "query", + "description": "limit", + "required": false, + "schema": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" + } + }, + { + "name": "greaterThanEquals", + "in": "query", + "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", + "required": false, + "schema": { + "type": "integer", + "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", + "examples": [1617383798468, 1617383798460] + } + }, + { + "name": "greaterThanEqualsField", + "in": "query", + "description": "Date field to compare.", + "required": false, + "schema": { + "type": "string", + "description": "Date field to compare.", + "examples": ["metrics.startDate"], + "enum": ["metrics.startDate"] + } + }, + { + "name": "equals", + "in": "query", + "description": "String value to compare with equalsField.", + "required": false, + "schema": { + "type": "string", + "description": "String value to compare with equalsField.", + "examples": ["exampleName"] + } + }, + { + "name": "equalsField", + "in": "query", + "description": "Field to compare with equals value.", + "required": false, + "schema": { + "type": "string", + "description": "Field to compare with equals value.", + "examples": ["workflow.name"], + "enum": ["workflow.name"] + } + } + ], + "operationId": "WorkFlowEngine.getTaskMetrics", + "responses": { + "200": { + "description": "metrics", + "content": { + "application/json": { + "schema": { + "title": "metrics", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow_engine_jobMetricsDocument" + } + }, + "skip": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" + }, + "limit": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" + }, + "total": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_total" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/workers/status": { + "get": { + "summary": "Get the current and future states of the task and job workers", + "description": "Get the current and future states of the task and job workers", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.getWorkerStatuses", + "responses": { + "200": { + "description": "Statuses of the job and task worker", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "jobWorker": { + "type": "object", + "properties": { + "running": { + "type": "boolean", + "description": "Whether the worker is currently running" + }, + "clusterValue": { + "type": "string", + "enum": ["enabled", "disabled", "not defined"], + "description": "Whether the service_config was set to enable this worker" + }, + "localValue": { + "type": "string", + "enum": ["enabled", "disabled", "not defined"], + "description": "Whether the properties.json was set to enable this worker" + }, + "startupValue": { + "type": "boolean", + "description": "Whether the clusterValue and localValue combined allow the worker to start" + } + } + }, + "taskWorker": { + "type": "object", + "properties": { + "running": { + "type": "boolean", + "description": "Whether the worker is currently running" + }, + "clusterValue": { + "type": "string", + "enum": ["enabled", "disabled", "not defined"], + "description": "Whether the service_config was set to enable this worker" + }, + "localValue": { + "type": "string", + "enum": ["enabled", "disabled", "not defined"], + "description": "Whether the properties.json was set to enable this worker" + }, + "startupValue": { + "type": "boolean", + "description": "Whether the clusterValue and localValue combined allow the worker to start" + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": false + } + }, + "/workflow_engine/active": { + "get": { + "summary": "Check Staterator State", + "description": "Check if Staterator is currently active", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.isActive", + "responses": { + "200": { + "description": "Active flag for Staterator", + "content": { + "application/json": { + "schema": { + "title": "state", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin"], + "CookieAuth": ["WorkFlowEngine.admin"], + "BasicAuth": ["WorkFlowEngine.admin"] + } + ], + "deprecated": true + } + }, + "/workflow_engine/query": { + "post": { + "summary": "Query Data Using 'json-query' Format", + "description": "Query data using a dot/bracket notation string and a matching key/value pair.", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.query", + "responses": { + "200": { + "description": "Returned data from the match query", + "content": { + "application/json": { + "schema": { + "title": "return_data", + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "object" + }, + { + "type": "array" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "examples": ["value"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "job_id": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_mongoObjectId" + }, + "pass_on_null": { + "title": "pass_on_null", + "type": "boolean" + }, + "query": { + "title": "query", + "type": "string", + "examples": ["name"] + }, + "obj": { + "title": "obj", + "type": "object", + "properties": {}, + "examples": [ + { + "name": "value" + } + ] + } + } + } + } + } + } + } + }, + "/workflow_engine/runEvaluationGroup": { + "post": { + "summary": "Evaluation", + "description": "Run a test evaluation.", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.runEvaluationGroup", + "responses": { + "200": { + "description": "Result of evaluation.", + "content": { + "application/json": { + "schema": { + "type": "boolean", + "title": "evaluation_group_value" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "evaluation_group": { + "title": "evaluation_group", + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_evaluationItem" + } + }, + "all_true_flag": { + "title": "all_true_flag", + "type": "boolean" + } + } + } + } + } + } + } + }, + "/workflow_engine/runEvaluationGroups": { + "post": { + "summary": "Evaluation Group", + "description": "Run a test evaluation group.", + "tags": ["workflow_engine"], + "parameters": [], + "operationId": "WorkFlowEngine.runEvaluationGroups", + "responses": { + "200": { + "description": "Result of evaluation.", + "content": { + "application/json": { + "schema": { + "type": "boolean", + "title": "return_value" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], + "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], + "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "evaluation_group": { + "title": "evaluation_group", + "type": "array", + "items": { + "type": "object", + "properties": { + "evaluations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_evaluationItem" + } + }, + "all_true_flag": { + "type": "boolean" + } + } + } + }, + "all_true_flag": { + "title": "all_true_flag", + "type": "boolean" + } + } + } + } + } + } + } + }, + "/json-forms/forms": { + "post": { + "summary": "Creates a Json Form", + "description": "Creates a new JSON form document with a unique name.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.createForm", + "responses": { + "200": { + "description": "document that was created from the request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "title": "name", + "type": "string", + "examples": ["Device Form"] + }, + "description": { + "title": "description", + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "struct": { + "$ref": "#/components/schemas/json-forms_formStruct" + }, + "schema": { + "$ref": "#/components/schemas/json-forms_formSchema_container" + }, + "uiSchema": { + "$ref": "#/components/schemas/json-forms_formUISchema_container" + }, + "bindingSchema": { + "$ref": "#/components/schemas/json-forms_formBindingSchema_bindingSchema" + }, + "validationSchema": { + "$ref": "#/components/schemas/json-forms_formValidationSchema_validationSchema" + } + } + } + } + } + } + }, + "get": { + "summary": "Returns all forms", + "description": "Returns all JSON form documents that have previously been created.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.getForms", + "responses": { + "200": { + "description": "An array of form documents.", + "content": { + "application/json": { + "schema": { + "title": "forms", + "type": "array", + "items": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + }, + "examples": [ + [ + { + "id": "62bf2e8333385420ffe7bdd7", + "createdBy": "admin@pronoghorn", + "lastUpdatedBy": "admin@pronghorn", + "struct": { + "type": "object", + "description": "", + "items": [] + }, + "bindingSchema": {}, + "validationSchema": {}, + "tags": [], + "created": "2022-07-01T17:27:31.335Z", + "lastUpdated": "2022-07-01T17:27:31.335Z", + "name": "form-name", + "description": "", + "schema": { + "title": "form-name", + "description": "", + "type": "object", + "required": [], + "properties": {} + }, + "uiSchema": {}, + "version": "2022.1" + } + ] + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Deletes a forms", + "description": "Delete a list of JSON Forms from IAP.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.deleteForms", + "responses": { + "200": { + "description": "The status and number of delete forms.", + "content": { + "application/json": { + "schema": { + "title": "document", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "failure"] + }, + "n": { + "type": "integer" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ids": { + "title": "ids", + "type": "array", + "items": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + } + } + } + } + } + } + } + } + }, + "/json-forms/forms/{id}": { + "get": { + "summary": "Finds a form", + "description": "Finds a previously created JSON form, based on a supplied document ID.", + "tags": ["json-forms"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique name of the form", + "required": true, + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_formId" + } + } + ], + "operationId": "JsonForms.getFormById", + "responses": { + "200": { + "description": "document of requested form", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates a form", + "description": "Updates a previously created JSON form, based on a supplied document ID and an object of fields to update.", + "tags": ["json-forms"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the form.", + "required": true, + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_formId" + } + } + ], + "operationId": "JsonForms.updateForm", + "responses": { + "200": { + "description": "A response object containing the request status and a message", + "content": { + "application/json": { + "schema": { + "title": "document", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": ["success", "failure"] + }, + "message": { + "type": "string", + "examples": ["Form updated"] + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + } + } + } + } + } + } + } + }, + "/json-forms/import/forms": { + "post": { + "summary": "Import form documents", + "description": "Insert form documents into the forms collection from a user supplied JSON document.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.importForms", + "responses": { + "200": { + "description": "Status of forms import operation", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "message": { + "type": "string", + "example": "2 forms imported successfully" + }, + "imported": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "original": { + "$ref": "#/components/schemas/json-forms_formDocument_importResultReport" + }, + "created": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/json-forms_formDocument_importResultReport" + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "forms": { + "title": "forms", + "type": "array", + "items": { + "$ref": "#/components/schemas/json-forms_formDocument_form" + } + } + } + } + } + } + } + } + }, + "/json-forms/validate-form/{id}": { + "post": { + "summary": "Validates form data against its schema", + "description": "Retrieves the JSON schema for a given form ID and validates the supplied form data again it.", + "tags": ["json-forms"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique ID of the form", + "required": true, + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_formId" + } + } + ], + "operationId": "JsonForms.validateForm", + "responses": { + "200": { + "description": "results from the form validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_validationResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "formData": { + "$ref": "#/components/schemas/json-forms_formDocument_formData" + } + } + } + } + } + } + } + }, + "/json-forms/validate-data": { + "post": { + "summary": "Validates data against a schema.", + "description": "Performs data validation, given a JSON schema and form data.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.validateData", + "responses": { + "200": { + "description": "results from the form validation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/json-forms_formDocument_validationResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jsonSchema": { + "$ref": "#/components/schemas/json-forms_metaSchema" + }, + "data": { + "$ref": "#/components/schemas/json-forms_formDocument_formData" + } + } + } + } + } + } + } + }, + "/json-forms/yangToSchema": { + "post": { + "summary": "Converts YANG to JSON Schema.", + "description": "onverts a list of YANG inputs into JSON Schemas", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.yangToSchema", + "responses": { + "200": { + "description": "Yang inputs converted to JSON schema", + "content": { + "application/json": { + "schema": { + "title": "jsonSchema", + "type": "array", + "items": { + "type": "object" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "yangData": { + "title": "yang", + "type": "array", + "items": { + "type": "string", + "description": "Yang module data in string format", + "examples": [ + "module Test { list interface { key \"name\"; leaf name { type string; } } }" + ] + } + } + } + } + } + } + } + } + }, + "/json-forms/decode": { + "post": { + "summary": "Decodes an encoded JSON Schema.", + "description": "Decodes an encoded JSON Schema.", + "tags": ["json-forms"], + "parameters": [], + "operationId": "JsonForms.decodeSchema", + "responses": { + "200": { + "description": "Decoded Json Schema", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "CookieAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ], + "BasicAuth": [ + "JsonForms.admin", + "JsonForms.other", + "JsonForms.readonly", + "JsonForms.apiread", + "JsonForms.operator" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jsonSchema": { + "title": "jsonSchema", + "type": "object" + } + } + } + } + } + } + } + }, + "/ag-manager/actions": { + "get": { + "summary": "Merge discovered actions from all IAG adapters", + "description": "Discovers all actions from inputed IAG adapters. This will restart this app and display a corresponding log message.", + "tags": ["ag-manager"], + "parameters": [], + "operationId": "AGManager.discoverAll", + "responses": { + "200": { + "description": "A pronghorn.json object.", + "content": { + "application/json": { + "schema": { + "title": "pronghornJson", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AGManager.admin", "AGManager.apiread"], + "CookieAuth": ["AGManager.admin", "AGManager.apiread"], + "BasicAuth": ["AGManager.admin", "AGManager.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskContinuation": { + "title": "Task Continuation", + "type": "boolean", + "default": true + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove discovered actions from all IAG adapter", + "description": "Discovers all actions from all IAG adapters. This will restart this app and display a corresponding log message.", + "tags": ["ag-manager"], + "parameters": [], + "operationId": "AGManager.undiscoverAll", + "responses": { + "200": { + "description": "A pronghorn.json object.", + "content": { + "application/json": { + "schema": { + "title": "pronghornJson", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AGManager.admin", "AGManager.apiwrite"], + "CookieAuth": ["AGManager.admin", "AGManager.apiwrite"], + "BasicAuth": ["AGManager.admin", "AGManager.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskContinuation": { + "title": "Task Continuation", + "type": "boolean", + "default": true + } + } + } + } + } + } + } + }, + "/ag-manager/actions/{adapterId}": { + "get": { + "summary": "Discover actions on one IAG adapter", + "description": "Discovers all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.", + "tags": ["ag-manager"], + "parameters": [ + { + "name": "adapterId", + "in": "path", + "description": "Automation Gateway adapter ID.", + "required": true, + "schema": { + "title": "adapterId", + "type": "string" + } + } + ], + "operationId": "AGManager.discoverModules", + "responses": { + "200": { + "description": "A pronghorn.json object.", + "content": { + "application/json": { + "schema": { + "title": "pronghornJson", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AGManager.admin", "AGManager.apiread"], + "CookieAuth": ["AGManager.admin", "AGManager.apiread"], + "BasicAuth": ["AGManager.admin", "AGManager.apiread"] + } + ], + "deprecated": false + }, + "delete": { + "summary": "Remove discovered actions from one IAG adapter", + "description": "Removes all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.", + "tags": ["ag-manager"], + "parameters": [ + { + "name": "adapterId", + "in": "path", + "description": "Automation Gateway adapter ID.", + "required": true, + "schema": { + "title": "adapterId", + "type": "string" + } + } + ], + "operationId": "AGManager.undiscoverModules", + "responses": { + "200": { + "description": "A pronghorn.json object.", + "content": { + "application/json": { + "schema": { + "title": "pronghornJson", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AGManager.admin", "AGManager.apiwrite"], + "CookieAuth": ["AGManager.admin", "AGManager.apiwrite"], + "BasicAuth": ["AGManager.admin", "AGManager.apiwrite"] + } + ], + "deprecated": false + } + }, + "/ag-manager/getClusterAdapters": { + "get": { + "summary": "Get all adapters in all clusters", + "description": "Get all adapters in all clusters", + "tags": ["ag-manager"], + "parameters": [], + "operationId": "AGManager.getClusterAdapters", + "responses": { + "200": { + "description": "A cluster adapter mapping object.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["AGManager.admin", "AGManager.apiread"], + "CookieAuth": ["AGManager.admin", "AGManager.apiread"], + "BasicAuth": ["AGManager.admin", "AGManager.apiread"] + } + ], + "deprecated": false + } + }, + "/workflow_builder/tasks/list": { + "get": { + "summary": "Get Tasks", + "description": "Get all Tasks.", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.getTasksList", + "responses": { + "200": { + "description": "List of all Tasks.", + "content": { + "application/json": { + "schema": { + "title": "task_list", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "location": { + "type": "string", + "enum": ["Application", "Adapter", "Broker"] + }, + "app": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["automatic", "manual", "operation"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + } + } + }, + "deprecated": { + "type": "boolean" + } + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false + } + }, + "/workflow_builder/getTaskDetails/{app}/{task}": { + "get": { + "summary": "Get Task Details", + "description": "Get a Task's details.", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "app", + "in": "path", + "description": "Application's name (export field in model)", + "required": true, + "schema": { + "title": "app", + "type": "string", + "examples": ["ConfigurationManager"] + } + }, + { + "name": "task", + "in": "path", + "description": "Task's id (hex)", + "required": true, + "schema": { + "title": "task", + "type": "string", + "pattern": "^[0-9a-f]{1,4}$" + } + } + ], + "operationId": "WorkflowBuilder.getTaskDetails", + "responses": { + "200": { + "description": "Detailed Task.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_anyTask" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false + } + }, + "/workflow_builder/workflows/schemas": { + "post": { + "summary": "Calculate incoming/outgoing schemas for the workflow", + "description": "calculate incoming/outgoing schemas for the workflow", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.getSchemas", + "responses": { + "200": { + "description": "Input/Output transformation schemas for the workflow", + "content": { + "application/json": { + "schema": { + "title": "data", + "type": "object", + "properties": { + "inputSchema": { + "type": "object" + }, + "outputSchema": { + "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + } + } + } + } + } + } + } + }, + "/workflow_builder/workflows/save": { + "post": { + "summary": "Add Workflow", + "description": "Add a Workflow to the database", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.saveWorkflow", + "responses": { + "200": { + "description": "The new Workflow with its data and ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + } + } + } + } + } + } + } + }, + "/workflow_builder/workflows/rename": { + "post": { + "summary": "Rename Workflow", + "description": "Rename a Workflow in the database", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.renameWorkflow", + "responses": { + "200": { + "description": "The renamed Workflow with its data and ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument" + }, + "newName": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + } + } + } + } + } + }, + "/workflow_builder/workflows/delete/{name}": { + "delete": { + "summary": "Delete Workflow", + "description": "Delete a Workflow from the database", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Workflow's name.", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.deleteWorkflow", + "responses": { + "200": { + "description": "Status of delete", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "CookieAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ], + "BasicAuth": [ + "WorkflowBuilder.admin", + "WorkflowBuilder.engineering", + "WorkflowBuilder.support" + ] + } + ], + "deprecated": false + } + }, + "/workflow_builder/workflows/{name}/groups": { + "get": { + "summary": "List Groups for a Workflow", + "description": "List the groups that have access to a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.listWorkflowGroups", + "responses": { + "200": { + "description": "List of Groups", + "content": { + "application/json": { + "schema": { + "title": "groups", + "type": "array", + "items": { + "title": "group", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "WorkflowBuilder.apiread", + "WorkflowBuilder.authorization" + ], + "CookieAuth": [ + "WorkflowBuilder.apiread", + "WorkflowBuilder.authorization" + ], + "BasicAuth": [ + "WorkflowBuilder.apiread", + "WorkflowBuilder.authorization" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Overwrite Groups for a Workflow", + "description": "Overwrite the list of groups that have access to a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.replaceWorkflowGroups", + "responses": { + "200": { + "description": "Status of Overwrite", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkflowBuilder.authorization"], + "CookieAuth": ["WorkflowBuilder.authorization"], + "BasicAuth": ["WorkflowBuilder.authorization"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "title": "groups", + "type": "array", + "items": { + "title": "group", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Add Group to Workflow", + "description": "Add a group to the list of groups for a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.createWorkflowGroupEntry", + "responses": { + "200": { + "description": "Status of Overwrite", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkflowBuilder.authorization"], + "CookieAuth": ["WorkflowBuilder.authorization"], + "BasicAuth": ["WorkflowBuilder.authorization"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group": { + "title": "group", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete all Groups for a Workflow", + "description": "Remove all authorization restriction for a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + } + ], + "operationId": "WorkflowBuilder.deleteWorkflowGroups", + "responses": { + "200": { + "description": "Status of Delete", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkflowBuilder.authorization"], + "CookieAuth": ["WorkflowBuilder.authorization"], + "BasicAuth": ["WorkflowBuilder.authorization"] + } + ], + "deprecated": false + } + }, + "/workflow_builder/workflows/{name}/groups/{group}": { + "delete": { + "summary": "Remove a Group from a Workflow", + "description": "Remove a group from the list of authorized groups for a Workflow", + "tags": ["workflow_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of Workflow", + "required": true, + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" + } + }, + { + "name": "group", + "in": "path", + "description": "A Group Name", + "required": true, + "schema": { + "title": "group", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + ], + "operationId": "WorkflowBuilder.removeWorkflowGroup", + "responses": { + "200": { + "description": "Status of Removal", + "content": { + "application/json": { + "schema": { + "title": "status", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkflowBuilder.authorization"], + "CookieAuth": ["WorkflowBuilder.authorization"], + "BasicAuth": ["WorkflowBuilder.authorization"] + } + ], + "deprecated": false + } + }, + "/workflow_builder/export": { + "post": { + "summary": "Export Workflow", + "description": "Export a single Workflow", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.exportWorkflow", + "responses": { + "200": { + "description": "Exported Workflow", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow_builder_workflowPayload" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"], + "CookieAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"], + "BasicAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectId", + "description": "Id of Workflow document", + "examples": [ + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "name": { + "type": "string", + "description": "The name of the workflow. When provided, 'type' can also be specified for additional filtering.", + "examples": ["ciscoIOSsoftwareUpgrade"] + }, + "type": { + "type": "string", + "description": "The type of the workflow. It is an optional field and is used in conjunction with 'name' for filtering." + } + }, + "required": ["_id", "name"], + "oneOf": [ + { + "required": ["_id"] + }, + { + "required": ["name"] + } + ], + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/workflow_builder/import": { + "post": { + "summary": "Import Workflow", + "description": "Import a single Workflow", + "tags": ["workflow_builder"], + "parameters": [], + "operationId": "WorkflowBuilder.importWorkflow", + "responses": { + "200": { + "description": "Import status Object", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "result" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["WorkflowBuilder.admin"], + "CookieAuth": ["WorkflowBuilder.admin"], + "BasicAuth": ["WorkflowBuilder.admin"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "$ref": "#/components/schemas/workflow_builder_workflowPayload" + }, + "options": { + "type": "object", + "properties": { + "adapterMap": { + "type": "object" + } + } + } + } + } + } + } + } + } + }, + "/template_builder/templates/{name}/renderJinja": { + "post": { + "summary": "Render Jinja Template", + "description": "Renders jinja template output.", + "tags": ["template_builder"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Template name", + "required": true, + "schema": { + "type": "string", + "examples": [ + "Template name 1", + "Template name 2", + "Template name 3" + ] + } + } + ], + "operationId": "TemplateBuilder.renderJinjaTemplate", + "responses": { + "200": { + "description": "Rendered jinja template", + "content": { + "application/json": { + "schema": { + "title": "renderedTemplate", + "type": "object", + "examples": [ + { + "renderedTemplate": "John was born in year 2000" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ], + "CookieAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ], + "BasicAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "context": { + "type": "object", + "examples": [ + { + "name": "John", + "DOB": "2000/1/1" + } + ] + } + } + } + } + } + } + } + }, + "/template_builder/parseTemplate": { + "post": { + "summary": "Parse templates based on the text and textfsm template sent in.", + "description": "Parse templates based on the text and textfsm template sent in.", + "tags": ["template_builder"], + "parameters": [], + "operationId": "TemplateBuilder.parseTemplate", + "responses": { + "200": { + "description": "Results from textfsm", + "content": { + "application/json": { + "schema": { + "title": "results", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ], + "CookieAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ], + "BasicAuth": [ + "TemplateBuilder.admin", + "TemplateBuilder.other", + "TemplateBuilder.readonly", + "TemplateBuilder.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/template_builder_parseTemplateInput" + } + } + } + } + } + } + } + }, + "/template_builder/applyTemplate": { + "post": { + "summary": "Apply a template to text", + "description": "Apply a template to parse text", + "tags": ["template_builder"], + "parameters": [], + "operationId": "TemplateBuilder.applyTemplate", + "responses": { + "200": { + "description": "Parsed object based on the template and text provided", + "content": { + "application/json": { + "schema": { + "title": "parsed", + "type": "object" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], + "CookieAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], + "BasicAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "text": { + "type": "string", + "examples": [ + "Template input text 1", + "Template input text 2", + "Template input text 3" + ] + }, + "template": { + "type": "string", + "examples": [ + "Template name 1", + "Template name 2", + "Template name 3" + ] + } + } + } + } + } + } + } + }, + "/template_builder/applyTemplates": { + "post": { + "summary": "Apply templates to text", + "description": "Apply templates to parse text", + "tags": ["template_builder"], + "parameters": [], + "operationId": "TemplateBuilder.applyTemplates", + "responses": { + "200": { + "description": "Parsed text based on the templates used", + "content": { + "application/json": { + "schema": { + "title": "parsed", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + [ + "Template output 1", + "Template output 2", + "Template output 3" + ] + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], + "CookieAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], + "BasicAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "text": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + [ + "Template input text 1", + "Template input text 2", + "Template input text 3" + ] + ] + }, + "templates": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + ["Template name 1", "Template name 2", "Template name 3"] + ] + } + } + } + } + } + } + } + }, + "/operations-manager/automations/clone": { + "post": { + "summary": "Clone Automation", + "description": "Clone an Automation.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.cloneAutomation", + "responses": { + "200": { + "description": "The result of the clone operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_automation-api" + }, + "metadata": { + "type": "object", + "properties": { + "automaticChanges": { + "type": "array", + "items": { + "title": "messages", + "type": "string", + "example": "Disabled trigger 628672e8f677b67b3b0f20d7" + } + }, + "triggerCloneResults": { + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": ["Imported 3 of 3 document(s)."] + }, + "metadata": { + "type": "object" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "data": { + "$ref": "#/components/schemas/operations-manager_trigger-api" + }, + "automaticChanges": { + "type": "array", + "items": { + "title": "messages", + "type": "string", + "example": "Disabled trigger 628672e8f677b67b3b0f20d7" + } + } + } + } + } + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "automation", + "content": { + "application/json": { + "schema": { + "title": "automation", + "properties": { + "id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + "name": { + "description": "An optional name to use for the clone.", + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/operations-manager_common_name" + } + ] + } + } + } + } + } + } + } + }, + "/operations-manager/automations": { + "post": { + "summary": "Create Automation", + "description": "Create a new Automation.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.createAutomation", + "responses": { + "200": { + "description": "The result of the create operation.", + "content": { + "application/json": { + "schema": { + "title": "results", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + "gbac": { + "$ref": "#/components/schemas/operations-manager_automation-common_gbac" + }, + "componentId": { + "$ref": "#/components/schemas/operations-manager_automation-common_componentId" + } + } + } + ] + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "automation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_automation-create" + } + } + } + } + }, + "get": { + "summary": "Get Automations", + "description": "Search the Automation collection.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.getAutomations", + "responses": { + "200": { + "description": "The Automations that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_automation-api" + } + }, + "metadata": { + "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Import Automations", + "description": "Import Automations.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.importAutomations", + "responses": { + "200": { + "description": "The result of the import operation.", + "content": { + "application/json": { + "schema": { + "title": "status", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + "gbac": { + "$ref": "#/components/schemas/operations-manager_automation-common_gbac" + }, + "componentId": { + "$ref": "#/components/schemas/operations-manager_automation-common_componentId" + } + } + } + ] + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "automations": { + "title": "automations", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_automation-json" + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "adapterMap": { + "type": "object", + "description": "A mapping of provenance names to be converted upon import, specified in \"old_name\": \"new_name\" format.", + "examples": [ + { + "staging": "production" + }, + { + "old_name": "new_name" + } + ] + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/operations-manager/automations/{id}": { + "delete": { + "summary": "Delete Automation", + "description": "Delete an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Automation to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteAutomation", + "responses": { + "200": { + "description": "The result of the delete operation.", + "content": { + "application/json": { + "schema": { + "title": "results", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "null" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false + }, + "get": { + "summary": "Get Automation", + "description": "Get an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Automation to get.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.getAutomation", + "responses": { + "200": { + "description": "The requested Automation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_automation-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update Automation", + "description": "Update an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Automation to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.updateAutomation", + "responses": { + "200": { + "description": "The result of the update operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + "gbac": { + "$ref": "#/components/schemas/operations-manager_automation-common_gbac" + }, + "componentId": { + "$ref": "#/components/schemas/operations-manager_automation-common_componentId" + } + } + } + ] + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_automation-update" + } + } + } + } + } + }, + "/operations-manager/automations/{id}/export": { + "get": { + "summary": "Export Automation", + "description": "Export an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Automation to export.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.exportAutomation", + "responses": { + "200": { + "description": "The result of the export operation.", + "content": { + "application/json": { + "schema": { + "title": "document", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_automation-json" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers": { + "get": { + "summary": "Get Triggers", + "description": "Search the Trigger collection.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "contains", + "in": "query", + "description": "the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document", + "required": false, + "schema": { + "type": "string", + "examples": ["event"], + "description": "the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document" + } + }, + { + "name": "containsField", + "in": "query", + "description": "the field to run a contains query on", + "required": false, + "schema": { + "type": "string", + "examples": ["name"], + "description": "the field to run a contains query on" + } + }, + { + "name": "equals", + "in": "query", + "description": "the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document", + "required": false, + "schema": { + "type": "string", + "examples": ["my event trigger"], + "description": "the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document" + } + }, + { + "name": "equalsField", + "in": "query", + "description": "the field to run an equals query on", + "required": false, + "schema": { + "type": "string", + "examples": ["name"], + "description": "the field to run an equals query on" + } + }, + { + "name": "startsWith", + "in": "query", + "description": "the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document", + "required": false, + "schema": { + "type": "string", + "examples": ["my"], + "description": "the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document" + } + }, + { + "name": "startsWithField", + "in": "query", + "description": "the field to run a startsWith query on", + "required": false, + "schema": { + "type": "string", + "examples": ["name"], + "description": "the field to run a startsWith query on" + } + }, + { + "name": "greaterThanField", + "in": "query", + "description": "the field to run a greater than query on", + "required": false, + "schema": { + "type": "string", + "examples": ["lastExecuted"], + "description": "the field to run a greater than query on" + } + }, + { + "name": "greaterThan", + "in": "query", + "description": "the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds", + "required": false, + "schema": { + "type": "string", + "examples": [ + "04/06/2021", + "Thu Dec 03 2020 14:55:00 GMT-0500 (Eastern Standard Time)", + "2020-12-03T19:55:43.189Z", + "1617681600000" + ], + "description": "the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds" + } + }, + { + "name": "lessThanField", + "in": "query", + "description": "the field to run a less than query on", + "required": false, + "schema": { + "type": "string", + "examples": ["lastExecuted"], + "description": "the field to run a less than query on" + } + }, + { + "name": "lessThan", + "in": "query", + "description": "the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds", + "required": false, + "schema": { + "type": "string", + "examples": [ + "04/06/2021", + "Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time)", + "2020-12-03T19:55:43.189Z", + "1615611600000" + ], + "description": "the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds" + } + }, + { + "name": "enabled", + "in": "query", + "description": "if true, then only return trigger documents that are enabled", + "required": false, + "schema": { + "type": "boolean", + "description": "if true, then only return trigger documents that are enabled" + } + }, + { + "name": "actionId", + "in": "query", + "description": "if provided, only return trigger documents with this action id", + "required": false, + "schema": { + "type": "string", + "description": "if provided, only return trigger documents with this action id" + } + }, + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by. Default is name.", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by. Default is name.", + "default": "name", + "enum": ["name"] + } + } + ], + "operationId": "OperationsManager.getTriggers", + "responses": { + "200": { + "description": "The Triggers that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_trigger-api" + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + }, + "post": { + "summary": "Create Trigger", + "description": "Create a new Trigger.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.createTrigger", + "responses": { + "200": { + "description": "The result of the create operation.", + "content": { + "application/json": { + "schema": { + "title": "createdTigger", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + ] + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "trigger", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_trigger-create" + } + } + } + } + }, + "put": { + "summary": "Import Triggers", + "description": "Import Triggers.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.importTriggers", + "responses": { + "200": { + "description": "The result of the import operation.", + "content": { + "application/json": { + "schema": { + "title": "createdTigger", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + ] + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "triggers": { + "title": "triggers", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_trigger-json" + } + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "adapterMap": { + "type": "object", + "description": "A mapping of provenance names to be converted upon import, specified in \"old_name\": \"new_name\" format.", + "examples": [ + { + "staging": "production" + }, + { + "old_name": "new_name" + } + ] + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "/operations-manager/triggers/{id}": { + "get": { + "summary": "Get Trigger", + "description": "Get a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Trigger to get.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.getTrigger", + "responses": { + "200": { + "description": "The requested Trigger.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_trigger-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Update Trigger", + "description": "Update a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Trigger to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.updateTrigger", + "responses": { + "200": { + "description": "The result of the update operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" + }, + { + "$ref": "#/components/schemas/operations-manager_common_metadataFields" + }, + { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + ] + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_trigger-update" + } + } + } + } + }, + "delete": { + "summary": "Delete Trigger", + "description": "Delete a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Trigger to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteTrigger", + "responses": { + "200": { + "description": "The result of the delete operation.", + "content": { + "application/json": { + "schema": { + "title": "success", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "null" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers/action/{id}": { + "delete": { + "summary": "Delete Triggers By Action ID", + "description": "Deletes all Triggers associated with the provided Automation id.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the parent Automation.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteTriggersByActionId", + "responses": { + "200": { + "description": "The result of the delete operation.", + "content": { + "application/json": { + "schema": { + "title": "deletedCount", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "null" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers/{id}/export": { + "get": { + "summary": "Export Trigger", + "description": "Export a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Trigger to export.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.exportTrigger", + "responses": { + "200": { + "description": "The result of the export operation.", + "content": { + "application/json": { + "schema": { + "title": "document", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_trigger-json" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/large-data/{id}": { + "get": { + "summary": "Export large data for a job or task variable", + "description": "Export large data for a job or task variable", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the job_data document in GridFS", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.exportLargeData", + "responses": { + "200": { + "description": "The requested data", + "content": { + "application/json": { + "schema": { + "title": "result", + "oneOf": [ + { + "type": "object" + }, + { + "type": "array" + }, + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "The decoded job data stored in GridFS" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/events": { + "get": { + "summary": "", + "description": "Search the system events that can be used in an event Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "source", + "in": "query", + "description": "source", + "required": false, + "schema": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" + } + }, + { + "name": "topic", + "in": "query", + "description": "topic", + "required": false, + "schema": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" + } + } + ], + "operationId": "OperationsManager.getEvents", + "responses": { + "200": { + "description": "The events that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" + }, + "topic": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/events/{source}/{topic}": { + "get": { + "summary": "", + "description": "Get an event definition.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "source", + "in": "path", + "description": "source", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" + } + }, + { + "name": "topic", + "in": "path", + "description": "topic", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" + } + } + ], + "operationId": "OperationsManager.getEventDefinition", + "responses": { + "200": { + "description": "The requested event definition.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" + }, + "topic": { + "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" + }, + "definition": { + "type": "object", + "description": "The schema of the event.", + "$comment": "See draft 7 specification: http://json-schema.org/draft-07/schema#" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers/endpoint/{routeName}": { + "post": { + "summary": "Run Endpoint Trigger With POST", + "description": "Runs the Automation associated with the API Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "routeName", + "in": "path", + "description": "The routeName of the API Trigger.", + "required": true, + "schema": { + "title": "routeName", + "type": "string" + } + } + ], + "operationId": "OperationsManager.runEndpointTriggerWithPost", + "responses": { + "200": { + "description": "The spawned Job.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "body", + "content": { + "application/json": { + "schema": { + "title": "body", + "type": "object", + "properties": {}, + "additionalProperties": true + } + } + } + } + } + }, + "/operations-manager/triggers/manual/{id}/run": { + "post": { + "summary": "Run Manual Trigger", + "description": "Runs the Automation associated with the Manual Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Manual Trigger to run.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.runManualTrigger", + "responses": { + "200": { + "description": "The spawned Job.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "formData": { + "title": "formData", + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "runtimeOptions": { + "title": "runtimeOptions", + "default": {}, + "properties": { + "targetType": { + "enum": ["instance", "group"] + }, + "targetIdentifier": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/tasks/{taskId}/retry": { + "post": { + "summary": "Retry a task", + "description": "Retry a Task that has failed execution.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job containing the Task.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "taskId", + "in": "path", + "description": "The id of the Task to be retried.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_task-common_taskId" + } + } + ], + "operationId": "OperationsManager.retryTask", + "responses": { + "200": { + "description": "The result of the retry operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["OperationsManager.retryUser"], + "CookieAuth": ["OperationsManager.retryUser"], + "BasicAuth": ["OperationsManager.retryUser"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "variables": { + "title": "variables", + "type": "object", + "properties": {}, + "additionalProperties": true + } + } + } + } + } + } + } + }, + "/operations-manager/tasks/{taskId}/claim": { + "post": { + "summary": "Claim a task", + "description": "Assign a Task to the current user.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "taskId", + "in": "path", + "description": "The id of the Task iteration to be claimed.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_uuid-v4" + } + } + ], + "operationId": "OperationsManager.claimTask", + "responses": { + "200": { + "description": "The result of the claim operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/tasks/{taskId}/assign": { + "post": { + "summary": "Assign a task to a user", + "description": "Assign a Task to a user.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "taskId", + "in": "path", + "description": "The id of the Task iteration to be assigned.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_uuid-v4" + } + } + ], + "operationId": "OperationsManager.assignTask", + "responses": { + "200": { + "description": "The result of the assign operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + }, + "/operations-manager/tasks/{taskId}/release": { + "post": { + "summary": "Release a currently assigned task", + "description": "Remove user assignment from a currently assigned Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "taskId", + "in": "path", + "description": "The id of the Task iteration to be released.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_uuid-v4" + } + } + ], + "operationId": "OperationsManager.releaseTask", + "responses": { + "200": { + "description": "The result of the release operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/tasks": { + "get": { + "summary": "Gets Tasks", + "description": "Search the Task collection.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Number of results to return. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of results to skip. Used for pagination.", + "required": false, + "schema": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + } + }, + { + "name": "order", + "in": "query", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "required": false, + "schema": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + } + }, + { + "name": "sort", + "in": "query", + "description": "Field to sort by", + "required": false, + "schema": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "in", + "in": "query", + "description": "Search for fields exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "not-in", + "in": "query", + "description": "Search for fields not exactly matching one of the given list options", + "required": false, + "schema": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string" + } + }, + { + "name": "equals", + "in": "query", + "description": "Returns results where the specified fields exactly match the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string" + } + }, + { + "name": "contains", + "in": "query", + "description": "Returns results where the specified fields contain the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields contain the given match string(s).", + "type": "string" + } + }, + { + "name": "starts-with", + "in": "query", + "description": "Returns results where the specified fields start with the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string" + } + }, + { + "name": "ends-with", + "in": "query", + "description": "Returns results where the specified fields end in the given match string(s).", + "required": false, + "schema": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string" + } + }, + { + "name": "dereference", + "in": "query", + "description": "Designates foreign key fields to dereference in the API output.", + "required": false, + "schema": { + "description": "Designates foreign key fields to dereference in the API output.", + "type": "string" + } + }, + { + "name": "gt", + "in": "query", + "description": "Returns results where the specified fields have values greater than the specified values.", + "required": false, + "schema": { + "description": "Returns results where the specified fields have values greater than the specified values.", + "type": "string" + } + }, + { + "name": "gte", + "in": "query", + "description": "Returns results where the specified fields have values greater than or equal to the specified values.", + "required": false, + "schema": { + "description": "Returns results where the specified fields have values greater than or equal to the specified values.", + "type": "string" + } + }, + { + "name": "lt", + "in": "query", + "description": "Returns results where the specified fields have values less than the specified values.", + "required": false, + "schema": { + "description": "Returns results where the specified fields have values less than the specified values.", + "type": "string" + } + }, + { + "name": "lte", + "in": "query", + "description": "Returns results where the specified fields have values less than or equal to the specified values.", + "required": false, + "schema": { + "description": "Returns results where the specified fields have values less than or equal to the specified values.", + "type": "string" + } + }, + { + "name": "q", + "in": "query", + "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", + "required": false, + "schema": { + "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", + "type": "string" + } + }, + { + "name": "actionableTasks", + "in": "query", + "description": "If true, only returns actionable tasks that the current user has write access to.", + "required": false, + "schema": { + "type": "boolean", + "description": "If true, only returns actionable tasks that the current user has write access to.", + "default": false + } + } + ], + "operationId": "OperationsManager.getTasks", + "responses": { + "200": { + "description": "The Tasks that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + }, + "metadata": { + "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/tasks/{id}": { + "get": { + "summary": "Get a task by ID", + "description": "Get a Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Task to get.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "dereference", + "in": "query", + "description": "Designates foreign key fields to dereference in the API output. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.", + "required": false, + "schema": { + "type": "string", + "description": "Designates foreign key fields to dereference in the API output. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.", + "examples": ["job", "accounts.metrics.owner"] + } + } + ], + "operationId": "OperationsManager.getTask", + "responses": { + "200": { + "description": "The requested Task.", + "content": { + "application/json": { + "schema": { + "title": "task", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_task-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/{jobId}/watch": { + "post": { + "summary": "Watch a Job", + "description": "Adds the current user to the list of watchers on a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to watch.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.watchJob", + "responses": { + "200": { + "description": "The result of the watch operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/unwatch": { + "post": { + "summary": "Unwatch Jobs", + "description": "Removes the current user from the list of watchers on multiple Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.unwatchJobs", + "responses": { + "200": { + "description": "The result of the unwatch operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/watch": { + "post": { + "summary": "Watch Jobs", + "description": "Adds the current user to the list of watchers on multiple Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.watchJobs", + "responses": { + "200": { + "description": "The result of the watch operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/unwatch": { + "post": { + "summary": "Unwatch Job", + "description": "Removes the current user from the list of watchers on a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to unwatch.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.unwatchJob", + "responses": { + "200": { + "description": "The result of the unwatch operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/{jobId}/add-watchers": { + "post": { + "summary": "Add watchers to a Job", + "description": "Adds user ids to the list of watchers on a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to assign watchers to.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.addWatchersToJob", + "responses": { + "200": { + "description": "The result of the add watchers operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userIds": { + "title": "userIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/tasks/{taskId}/finish": { + "post": { + "summary": "Finish a manual task", + "description": "Work a manual Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job containing the Task to be worked.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "taskId", + "in": "path", + "description": "The id of the Task to be worked.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_job-common_taskId" + } + } + ], + "operationId": "OperationsManager.finishManualTask", + "responses": { + "200": { + "description": "The result of the finish manual Task operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "taskData": { + "title": "taskData", + "type": "object", + "properties": { + "finish_state": { + "type": "string" + }, + "variables": { + "type": "object" + } + }, + "required": ["finish_state", "variables"] + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/tasks/{taskId}/manual-controller": { + "get": { + "summary": "Get a client-side dialog controller for a manual task", + "description": "Get a client-side dialog controller for a manual task", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job containing the task", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "taskId", + "in": "path", + "description": "The id of the Task containing the dialog controller.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_task-common_taskId" + } + } + ], + "operationId": "OperationsManager.getManualTaskController", + "responses": { + "200": { + "description": "The requested dialog controller.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string" + }, + "decorators": { + "$ref": "#/components/schemas/operations-manager_common_decorators" + } + } + }, + "finish_state": { + "type": "string" + }, + "TaskController": { + "type": "string", + "description": "A Javascript function named TaskController." + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiread", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/{id}": { + "get": { + "summary": "Get a Job", + "description": "Get a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The id of the Job to get.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "include", + "in": "query", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + } + }, + { + "name": "exclude", + "in": "query", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "required": false, + "schema": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + } + }, + { + "name": "dereference", + "in": "query", + "description": "Designates foreign key fields to dereference in the API output.", + "required": false, + "schema": { + "type": "string", + "description": "Designates foreign key fields to dereference in the API output.", + "examples": ["tasks", "accounts.createdBy"] + } + } + ], + "operationId": "OperationsManager.getJob", + "responses": { + "200": { + "description": "The requested Job.", + "content": { + "application/json": { + "schema": { + "title": "job", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs": { + "get": { + "summary": "Gets Jobs", + "description": "Search the Job collection.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.getJobs", + "responses": { + "200": { + "description": "The Jobs that matched the search query.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + }, + "metadata": { + "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiread", + "OperationsManager.operations", + "OperationsManager.viewer" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/start": { + "post": { + "summary": "Start a Job", + "description": "Spawns a Job from a Workflow.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.startJob", + "responses": { + "200": { + "description": "The spawned Job.", + "content": { + "application/json": { + "schema": { + "title": "job", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/operations-manager_job-api" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "workflow": { + "title": "workflow", + "type": "string" + }, + "options": { + "title": "options", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description for the new Job.", + "examples": ["Example job description"] + }, + "type": { + "type": "string", + "examples": ["automation"] + }, + "variables": { + "type": "object", + "description": "Variables for the new Job.", + "additionalProperties": true + }, + "groups": { + "type": "array", + "description": "GBAC for the new Job.", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/pause": { + "post": { + "summary": "Pauses Jobs", + "description": "Pause active Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.pauseJobs", + "responses": { + "200": { + "description": "The result of the pause operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/resume": { + "post": { + "summary": "Resumes Jobs", + "description": "Resumes paused Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.resumeJobs", + "responses": { + "200": { + "description": "The result of the resume operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/cancel": { + "post": { + "summary": "Cancels Jobs", + "description": "Cancel Active Jobs.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.cancelJobs", + "responses": { + "200": { + "description": "The result of the cancel operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.engineering", + "OperationsManager.apiwrite", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "type": "array", + "title": "jobIds", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/groups": { + "post": { + "summary": "Add GBAC to a Job", + "description": "Add a group id to the groups array of a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to modify.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.addJobGroup", + "responses": { + "200": { + "description": "The result of the add group operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "const": true + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupId": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove all GBAC from a Job", + "description": "Remove all groups from the groups array of a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to modify.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteJobGroups", + "responses": { + "200": { + "description": "The result of the delete groups operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "const": true + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Replace all GBAC from a Job with the provided list", + "description": "Replace all groups from the groups array of a Job with the provided group array.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to modify.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.replaceJobGroups", + "responses": { + "200": { + "description": "The result of the replace groups operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "const": true + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "title": "groups", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/groups/{groupId}": { + "delete": { + "summary": "Remove GBAC from a Job", + "description": "Remove a group id from the groups array of a Job.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to modify.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + }, + { + "name": "groupId", + "in": "path", + "description": "The group id to add to the Job.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteJobGroup", + "responses": { + "200": { + "description": "The result of the delete group operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "const": true + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/{jobId}": { + "delete": { + "summary": "Delete a root job and all related items", + "description": "Only succeeds on completed or cancelled root jobs. Recursively deletes children, tasks, job data, job history, and large files.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.deleteJob", + "responses": { + "200": { + "description": "The result of the delete job operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object" + } + }, + "metadata": { + "type": "object" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/jobs/delete": { + "post": { + "summary": "Deletes a list of provided root jobs and all their related items", + "description": "Only succeeds on completed or cancelled root jobs. Ignores jobs that don't fit that criteria. Recursively deletes children, tasks, job data, job history, and large files.", + "tags": ["operations-manager"], + "parameters": [], + "operationId": "OperationsManager.deleteJobs", + "responses": { + "200": { + "description": "The result of the delete jobs operation.", + "content": { + "application/json": { + "schema": { + "title": "result", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object" + } + }, + "metadata": { + "type": "object" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobIds": { + "title": "jobIds", + "type": "array", + "items": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/continue": { + "post": { + "summary": "Continue a Job from a specified Task", + "description": "Continue a Job from a specified Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to be continued.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.continueJobFrom", + "responses": { + "200": { + "description": "The result of the continue operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["OperationsManager.retryUser"], + "CookieAuth": ["OperationsManager.retryUser"], + "BasicAuth": ["OperationsManager.retryUser"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fromTask": { + "$ref": "#/components/schemas/operations-manager_task-common_taskId" + } + } + } + } + } + } + } + }, + "/operations-manager/jobs/{jobId}/revert": { + "post": { + "summary": "Revert a Job", + "description": "Revert a paused Job from an errored Task to a previously completed Task.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "jobId", + "in": "path", + "description": "The id of the Job to be reverted.", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.revertJob", + "responses": { + "200": { + "description": "The result of the revert operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering", + "OperationsManager.operations" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fromTask": { + "$ref": "#/components/schemas/operations-manager_task-common_taskId" + }, + "toTask": { + "$ref": "#/components/schemas/operations-manager_job-common_taskId" + } + } + } + } + } + } + } + }, + "/operations-manager/automations/{automationIdentifier}/validate": { + "post": { + "summary": "Validate Automation", + "description": "Run configuration validations against an Automation.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "automationIdentifier", + "in": "path", + "description": "automationIdentifier", + "required": true, + "schema": { + "title": "automationIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/operations-manager_common_name" + } + ] + } + } + ], + "operationId": "OperationsManager.validateAutomation", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + }, + "warnings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false + } + }, + "/operations-manager/triggers/{triggerId}/validate": { + "post": { + "summary": "Validate Trigger", + "description": "Run configuration validations against a Trigger.", + "tags": ["operations-manager"], + "parameters": [ + { + "name": "triggerId", + "in": "path", + "description": "triggerId", + "required": true, + "schema": { + "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" + } + } + ], + "operationId": "OperationsManager.validateTrigger", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/operations-manager_common-api_success-response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + }, + "warnings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "CookieAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ], + "BasicAuth": [ + "OperationsManager.admin", + "OperationsManager.apiwrite", + "OperationsManager.engineering" + ] + } + ], + "deprecated": false + } + }, + "/mop/export": { + "post": { + "summary": "Export Template", + "description": "Export a single template", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.exportTemplate", + "responses": { + "200": { + "description": "Exported Template", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + }, + { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiread"], + "CookieAuth": ["MOP.admin", "MOP.apiread"], + "BasicAuth": ["MOP.admin", "MOP.apiread"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "title": "options", + "type": "object", + "examples": [ + { + "_id": "mop_test_123" + }, + { + "name": "mop_test_123" + } + ] + }, + "type": { + "title": "type", + "type": "string", + "enum": ["templates", "analytics"] + } + } + } + } + } + } + } + }, + "/mop/import": { + "post": { + "summary": "Import Template", + "description": "Import a single template", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.importTemplate", + "responses": { + "200": { + "description": "Import status", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "boolean" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "anyOf": [ + { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + }, + { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + ] + }, + "type": { + "type": "string", + "title": "type", + "enum": ["templates", "analytics"] + } + } + } + } + } + } + } + }, + "/mop/listTemplates": { + "get": { + "summary": "Get All Command Templates", + "description": "Get all Command Templates.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.listTemplates", + "responses": { + "200": { + "description": "All Command Templates.", + "content": { + "application/json": { + "schema": { + "title": "listTemplates", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false + } + }, + "/mop/listATemplate/{name}": { + "get": { + "summary": "Get a Command Template by Name", + "description": "Get a Command Template by name.", + "tags": ["mop"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the Command Template.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_name" + } + } + ], + "operationId": "MOP.listATemplate", + "responses": { + "200": { + "description": "Single Command Template matching the name.", + "content": { + "application/json": { + "schema": { + "title": "listATemplate", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false + } + }, + "/mop/listAnAnalyticTemplate/{name}": { + "get": { + "summary": "Get an Analytic Template by Name", + "description": "Get an Analytic Template by name.", + "tags": ["mop"], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the Analytic Template.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc_name" + } + } + ], + "operationId": "MOP.listAnAnalyticTemplate", + "responses": { + "200": { + "description": "Single Analytic Template wrapped in an array.", + "content": { + "application/json": { + "schema": { + "title": "listAnAnalyticTemplate", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false + } + }, + "/mop/listAnalyticTemplates": { + "get": { + "summary": "Get All Analytic Templates", + "description": "Get all Analytic Templates.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.listAnalyticTemplates", + "responses": { + "200": { + "description": "All Analytic Templates.", + "content": { + "application/json": { + "schema": { + "title": "listAnalyticTemplates", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false + } + }, + "/mop/createTemplate": { + "post": { + "summary": "Create a Command Template", + "description": "Create a Command Template.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.createTemplate", + "responses": { + "200": { + "description": "Result of the creation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mop": { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + } + } + } + } + } + } + } + }, + "/mop/createAnalyticTemplate": { + "post": { + "summary": "Create an Analytic Template", + "description": "Create an Analytic Template.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.createAnalyticTemplate", + "responses": { + "200": { + "description": "Result of the creation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + } + } + } + } + }, + "/mop/deleteTemplate/{id}": { + "post": { + "summary": "Delete a Command Template", + "description": "Delete a Command Template by ID.", + "tags": ["mop"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ID of the template to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc__id" + } + } + ], + "operationId": "MOP.deleteTemplate", + "responses": { + "200": { + "description": "Status of the deletion.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false + } + }, + "/mop/deleteAnalyticTemplate/{id}": { + "post": { + "summary": "Delete an Analytic Template", + "description": "Delete an Analytic Template by ID.", + "tags": ["mop"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ID of the Analytic Template to delete.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc__id" + } + } + ], + "operationId": "MOP.deleteAnalyticTemplate", + "responses": { + "200": { + "description": "Status of the deletion.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false + } + }, + "/mop/updateTemplate/{mopID}": { + "post": { + "summary": "Update a Command Template", + "description": "Update a Command Template by ID.", + "tags": ["mop"], + "parameters": [ + { + "name": "mopID", + "in": "path", + "description": "ID of the Command Template to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_name" + } + }, + { + "name": "mop", + "in": "path", + "description": "Command Template to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc" + } + } + ], + "operationId": "MOP.updateTemplate", + "responses": { + "200": { + "description": "Status of the update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false + } + }, + "/mop/updateAnalyticTemplate/{mopID}": { + "post": { + "summary": "Update an Analytic Template", + "description": "Update an Analytic Template by ID.", + "tags": ["mop"], + "parameters": [ + { + "name": "mopID", + "in": "path", + "description": "ID of the Analytic Template to update.", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc__id" + } + } + ], + "operationId": "MOP.updateAnalyticTemplate", + "responses": { + "200": { + "description": "Status of the update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + } + } + } + } + }, + "/mop/RunCommandDevices": { + "post": { + "summary": "Run a Command against Devices", + "description": "Run a command against devices.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.RunCommandDevices", + "responses": { + "200": { + "description": "Result of the command run.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "command": { + "title": "command", + "type": "string", + "examples": ["show version"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + }, + "devices": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + } + } + } + } + } + } + } + }, + "/mop/RunCommand": { + "post": { + "summary": "Run a Command against a Device", + "description": "Run a command against a device.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.RunCommand", + "responses": { + "200": { + "description": "Result of the command run.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "command": { + "title": "command", + "type": "string", + "examples": ["show version"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + }, + "device": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_device" + } + } + } + } + } + } + } + }, + "/mop/RunCommandTemplate": { + "post": { + "summary": "Run Command Template", + "description": "Run a Command Template against devices.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.RunCommandTemplate", + "responses": { + "200": { + "description": "Result of the Command Template run.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "title": "template", + "type": "string", + "examples": ["show version"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + }, + "devices": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + } + } + } + } + } + } + } + }, + "/mop/RunCommandTemplateSingleCommand": { + "post": { + "summary": "Run single command from template", + "description": "Run a single command from a template on a devices.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.RunCommandTemplateSingleCommand", + "responses": { + "200": { + "description": "Result of the Command Template run.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "templateId": { + "$ref": "#/components/schemas/mop_mopTemplateDoc__id" + }, + "commandIndex": { + "title": "commandIndex", + "type": "integer", + "examples": [0] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + }, + "devices": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + } + } + } + } + } + } + } + }, + "/mop/GetBootFlash": { + "post": { + "summary": "MOP Get Boot Flash", + "description": "Get the boot flash image", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.GetBootFlash", + "responses": { + "200": { + "description": "Binary file name currently being used by router", + "content": { + "application/json": { + "schema": { + "title": "imageName", + "type": "string", + "examples": ["10011011"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiread" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "device": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_device" + } + } + } + } + } + } + } + }, + "/mop/passThru/{device}": { + "post": { + "summary": "MOP Pass Thru", + "description": "Pass Through to execute direct device commands", + "tags": ["mop"], + "parameters": [ + { + "name": "device", + "in": "path", + "description": "device", + "required": true, + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_device" + } + } + ], + "operationId": "MOP.passThru", + "responses": { + "200": { + "description": "config", + "content": { + "application/json": { + "schema": { + "title": "config", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "command": { + "title": "command", + "type": "string", + "examples": ["show version"] + } + } + } + } + } + } + } + }, + "/mop/deviceObjects": { + "post": { + "summary": "Get Filtered Devices", + "description": "Get the devices with name matching the given options.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.getDeviceObjectsFiltered", + "responses": { + "200": { + "description": "Filtered devices", + "content": { + "application/json": { + "schema": { + "title": "devices", + "type": "array", + "items": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_detailedDevice" + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "options": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_options" + } + } + } + } + } + } + } + }, + "/mop/devices/detailed/{substring}": { + "get": { + "summary": "Get Filtered Devices with detailed query results", + "description": "Get the devices with name matching the given string. Also returns the number of results found and number returned", + "tags": ["mop"], + "parameters": [ + { + "name": "substring", + "in": "path", + "description": "String to filter devices", + "required": true, + "schema": { + "title": "substring", + "type": "string", + "examples": ["tes"] + } + } + ], + "operationId": "MOP.getDevicesFilteredDetailedResults", + "responses": { + "200": { + "description": "Filtered devices", + "content": { + "application/json": { + "schema": { + "title": "devices", + "type": "object", + "properties": { + "num_results": { + "type": "integer" + }, + "results": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + }, + "total_results": { + "type": "integer" + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] + } + ], + "deprecated": false + } + }, + "/mop/diff": { + "post": { + "summary": "Find the diff of two config strings.", + "description": "Find the diff of two config strings.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.getDiff", + "responses": { + "200": { + "description": "Result of the diff.", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "array", + "items": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "value": { + "type": "string" + }, + "added": { + "type": "boolean" + }, + "removed": { + "type": "boolean" + } + } + }, + "examples": [ + [ + [ + { + "count": 1, + "value": "example string\n" + }, + { + "count": 2, + "removed": true, + "value": "example string\nextra added line" + } + ] + ] + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.apiwrite"], + "CookieAuth": ["MOP.admin", "MOP.apiwrite"], + "BasicAuth": ["MOP.admin", "MOP.apiwrite"] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "value_a": { + "title": "value_a", + "type": "string", + "examples": ["any string"] + }, + "value_b": { + "title": "value_b", + "type": "string", + "examples": ["other string"] + } + } + } + } + } + } + } + }, + "/mop/runTemplatesDiffArray": { + "post": { + "summary": "MOP Diff Array", + "description": "Generates a diff for the input. By default, the API call timeout is 5 minutes for the platform. If this API call needs additional time, it can be modified in the Express timeout property. The supported timeout range would be a minimum of 8 minutes for a 2MB payload and a maximum of 32 minutes for a 4MB payload.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.runTemplatesDiffArray", + "responses": { + "200": { + "description": "diff", + "content": { + "application/json": { + "schema": { + "title": "diff", + "type": "object", + "properties": { + "onlyPre": { + "type": "object", + "properties": {} + }, + "diff": { + "type": "object", + "properties": {} + }, + "onlyPost": { + "type": "object", + "properties": {} + }, + "analytics": { + "type": "object", + "properties": {} + } + } + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ] + } + ], + "deprecated": true, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pre": { + "title": "pre", + "type": "array", + "items": { + "type": "string", + "examples": ["show version"] + } + }, + "post": { + "title": "post", + "type": "array", + "items": { + "type": "string", + "examples": ["show version"] + } + } + } + } + } + } + } + } + }, + "/mop/runAnalyticsTemplate": { + "post": { + "summary": "Run an Analytics Template", + "description": "Run an Analytic Template.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.runAnalyticsTemplate", + "responses": { + "200": { + "description": "Result of running Analytic Template", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pre": { + "title": "pre", + "type": "object", + "properties": { + "command": { + "type": "string" + }, + "commands_results": { + "type": "string" + } + }, + "examples": [ + { + "command": "show version", + "commands_results": "Cisco IOS Software, Version 1.2.3" + } + ] + }, + "post": { + "title": "post", + "type": "object", + "properties": { + "command": { + "type": "string" + }, + "commands_results": { + "type": "string" + } + }, + "examples": [ + { + "command": "show version", + "commands_results": "Cisco IOS Software, Version 1.2.3" + } + ] + }, + "analytic_template_name": { + "title": "analytic_template_name", + "type": "string", + "examples": ["test"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + } + } + } + } + } + } + } + }, + "/mop/runAnalyticsTemplateDevices": { + "post": { + "summary": "Run an Analytics Template for Devices", + "description": "Run an Analytic Template for Devices.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.runAnalyticsTemplateDevices", + "responses": { + "200": { + "description": "Result of running Analytic Template Devices", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pre": { + "title": "pre", + "type": "object", + "properties": { + "pre": { + "type": "object", + "properties": { + "commands_results": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["commands_results"], + "additionalProperties": false + } + } + }, + "post": { + "title": "post", + "type": "object", + "properties": { + "post": { + "type": "object", + "properties": { + "commands_results": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["commands_results"], + "additionalProperties": false + } + } + }, + "analytic_template_name": { + "title": "analytic_template_name", + "type": "string", + "examples": ["test"] + }, + "variables": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" + } + } + } + } + } + } + } + }, + "/mop/reattempt": { + "post": { + "summary": "Retry a task automatically for x number of attempts with n minute intervals.", + "description": "Workflow will follow reattempt task's outgoing transition after n minutes of delay.", + "tags": ["mop"], + "parameters": [], + "operationId": "MOP.reattempt", + "responses": { + "200": { + "description": "Response from attempt", + "content": { + "application/json": { + "schema": { + "title": "response", + "type": "string", + "examples": ["Success"] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "CookieAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ], + "BasicAuth": [ + "MOP.admin", + "MOP.engineering", + "MOP.support", + "MOP.apiwrite" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "job_id": { + "title": "job_id", + "type": "string", + "examples": ["test"] + }, + "attemptID": { + "title": "attemptID", + "type": "string", + "examples": ["test1234"] + }, + "minutes": { + "title": "minutes", + "type": "integer", + "examples": [1] + }, + "attempts": { + "title": "attempts", + "type": "integer", + "examples": [2] + } + } + } + } + } + } + } + }, + "/mop/devices/{substring}": { + "get": { + "summary": "Get Filtered Devices", + "description": "Get the devices with name matching the given string.", + "tags": ["mop"], + "parameters": [ + { + "name": "substring", + "in": "path", + "description": "String to filter devices", + "required": true, + "schema": { + "title": "substring", + "type": "string", + "examples": ["tes"] + } + } + ], + "operationId": "MOP.getDevicesFiltered", + "responses": { + "200": { + "description": "Filtered devices", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], + "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/action-executions/{executionId}/cancel": { + "post": { + "summary": "Cancels an action execution", + "description": "Cancels an action execution, if targeting a bulk action execution, all its child executions will also be canceled.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "executionId", + "in": "path", + "description": "executionId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.cancelActionExecution", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/groups": { + "post": { + "summary": "Creates a new instance group", + "description": "Creates a new instance group", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.createInstanceGroupHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "instanceGroup", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-create" + } + } + } + } + }, + "get": { + "summary": "Gets multiple instance groups", + "description": "Gets multiple instance groups", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.getInstanceGroupsHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" + } + }, + "metadata": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources": { + "post": { + "summary": "Creates a new resource model", + "description": "Creates a new resource model", + "tags": ["lifecycle-manager"], + "parameters": [], + "operationId": "LifecycleManager.createResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "resourceModelData", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-create-data" + } + } + } + } + }, + "get": { + "summary": "Searches resource models", + "description": "Searches resource models", + "tags": ["lifecycle-manager"], + "parameters": [], + "operationId": "LifecycleManager.getResourceModelsHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" + } + }, + "metadata": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/groups/{groupIdentifier}": { + "delete": { + "summary": "Deletes an instance group", + "description": "Deletes an instance group", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + }, + { + "name": "groupIdentifier", + "in": "path", + "description": "groupIdentifier", + "required": true, + "schema": { + "title": "groupIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.deleteInstanceGroupHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + }, + "get": { + "summary": "Gets a single instance group", + "description": "Gets a single new instance group", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + }, + { + "name": "groupIdentifier", + "in": "path", + "description": "groupIdentifier", + "required": true, + "schema": { + "title": "groupIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.getInstanceGroupHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + }, + "patch": { + "summary": "Updates a instance group", + "description": "Updates a instance group", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + }, + { + "name": "groupIdentifier", + "in": "path", + "description": "groupIdentifier", + "required": true, + "schema": { + "title": "groupIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.updateInstanceGroupHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_instance-group-update" + } + } + } + } + } + }, + "/lifecycle-manager/resources/{id}": { + "delete": { + "summary": "Deletes a resource model", + "description": "A resource model will not be deleted if it has associated instances. To override this behavior and delete the resource model along with any associated instances, set the 'delete-associated-instances' flag to 'true'.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" + } + } + ], + "operationId": "LifecycleManager.deleteResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "queryParameters": { + "title": "queryParameters", + "type": "object", + "properties": { + "delete-associated-instances": { + "description": "If set to 'true', the resource model and any of its associated instances will be deleted.", + "type": "string" + } + }, + "required": [] + } + } + } + } + } + } + }, + "get": { + "summary": "Gets a resource model based on id", + "description": "Gets a resource model based on id", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ObjectId of the resource model", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" + } + }, + { + "name": "dereference", + "in": "query", + "description": "dereference", + "required": false, + "schema": { + "type": "string" + } + } + ], + "operationId": "LifecycleManager.getResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates a resource model", + "description": "Updates a resource model", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" + } + } + ], + "operationId": "LifecycleManager.updateResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "title": "updates", + "type": "object", + "properties": {} + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelId}/edit": { + "post": { + "summary": "Performs edits to a resource model", + "description": "Performs edits to a resource model. This method exists to support specific resource edit activities required by the UI.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Resource model ID", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.editResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "properties", + "content": { + "application/json": { + "schema": { + "title": "properties", + "oneOf": [ + { + "type": "object", + "required": ["command", "action"], + "properties": { + "command": { + "type": "string", + "description": "Edit command to execute", + "enum": [ + "generate-action-workflow", + "generate-action-pre-transformation", + "generate-action-post-transformation" + ] + }, + "action": { + "description": "Resource action ID or pending action definition", + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action" + } + ] + }, + "overwrite": { + "description": "Tells the component generator to either disregard and overwrite an existing component on the action (when true) or to refuse to generate a new component (when false).", + "type": "boolean" + }, + "updateAction": { + "description": "Tells the component generator to either update the action in the database (when true) or to only generate and return the new component (when false)", + "type": "boolean" + } + } + } + ] + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/instances/{instanceIdentifier}/export": { + "get": { + "summary": "Exports a resource instance", + "description": "This method exports a resource instance.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + }, + { + "name": "instanceIdentifier", + "in": "path", + "description": "instanceIdentifier", + "required": true, + "schema": { + "title": "instanceIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.exportResourceInstanceHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-export" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelId}/export": { + "get": { + "summary": "Exports a resource model", + "description": "This method exports a resource model.", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "modelId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.exportResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": true, + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-export" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/action-executions/{id}": { + "get": { + "summary": "Gets a single action execution record", + "description": "Gets a single action execution record", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.getActionExecution", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": true, + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/action-executions": { + "get": { + "summary": "Searches resource action history documents", + "description": "Searches resource action history documents", + "tags": ["lifecycle-manager"], + "parameters": [], + "operationId": "LifecycleManager.getActionExecutions", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": true, + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" + } + }, + "metadata": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelId}/instances/{instanceId}": { + "get": { + "summary": "Gets a single resource instance", + "description": "Gets a single resource instance", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "modelId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + }, + { + "name": "instanceId", + "in": "path", + "description": "The identifier of the resource instance", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.getResourceInstanceHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer", + "LifecycleManager.operator" + ] + } + ], + "deprecated": false + }, + "put": { + "summary": "Updates the `name` and `description` fields of a resource instance", + "description": "Updates the `name` and `description` fields of a resource instance", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "modelId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + }, + { + "name": "instanceId", + "in": "path", + "description": "instanceId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.updateInstanceMetadataHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "updates", + "content": { + "application/json": { + "schema": { + "title": "updates", + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_name" + }, + "description": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_description" + } + } + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelId}/instances": { + "get": { + "summary": "Searches resource instances", + "description": "Searches resource instances", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "modelId", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.getResourceInstancesHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + }, + "metadata": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/instances/import": { + "post": { + "summary": "Imports an instance into a resource", + "description": "Imports an instance into a resource", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "modelIdentifier", + "required": true, + "schema": { + "title": "modelIdentifier", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + } + } + ], + "operationId": "LifecycleManager.importResourceInstanceHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "properties": { + "data": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "instance", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-export" + } + } + } + } + } + }, + "/lifecycle-manager/resources/import": { + "post": { + "summary": "Imports a resource model", + "description": "Imports a resource model", + "tags": ["lifecycle-manager"], + "parameters": [], + "operationId": "LifecycleManager.importResourceModelHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + }, + { + "type": "object", + "additionalProperties": true, + "properties": { + "data": { + "type": "object", + "additionalProperties": false, + "properties": { + "_id": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + }, + "name": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_name" + } + } + } + } + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "importParameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-import" + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelId}/run-action": { + "post": { + "summary": "Runs a resource action", + "description": "Runs a resource action", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "The ID of the Resource Model to run an action on", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.runActionHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "required": ["actionId"], + "additionalProperties": false, + "properties": { + "actionId": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" + }, + "instance": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" + } + ] + }, + "instanceName": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_name" + }, + "instanceDescription": { + "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_description" + }, + "inputs": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelIdentifier}/run-bulk-action": { + "post": { + "summary": "Runs a resource action against multiple instances", + "description": "Runs a resource action against multiple instances", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelIdentifier", + "in": "path", + "description": "The ID of the Resource Model to run an action on.", + "required": true, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_name" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + ] + } + } + ], + "operationId": "LifecycleManager.runBulkActionHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiwrite", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "options", + "content": { + "application/json": { + "schema": { + "title": "options", + "type": "object", + "required": ["actionId"], + "additionalProperties": false, + "properties": { + "actionId": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" + }, + "group": { + "title": "groupIdentifier", + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" + }, + { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + ] + }, + "instances": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lifecycle-manager_common_name" + } + }, + "inputs": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "inputOverrides": { + "oneOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ] + } + } + } + } + } + } + } + }, + "/lifecycle-manager/resources/{modelId}/actions/validate": { + "post": { + "summary": "Validates the actions defined on a resource model", + "description": "This method validates the actions on a resource model. Each validation report has an associate severity, and designates whether or not it will prevent the action from saving, prevent the model from running, or both. It accepts pending edits to actions in the optional 'actions' body parameter in order to check for validation issues on unsaved, pending changes to an action", + "tags": ["lifecycle-manager"], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Resource model ID", + "required": true, + "schema": { + "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" + } + } + ], + "operationId": "LifecycleManager.validateActionsHttp", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "response", + "allOf": [ + { + "$ref": "#/components/schemas/lifecycle-manager_common-http_response" + } + ] + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "CookieAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ], + "BasicAuth": [ + "LifecycleManager.admin", + "LifecycleManager.apiread", + "LifecycleManager.designer" + ] + } + ], + "deprecated": false, + "requestBody": { + "description": "properties", + "content": { + "application/json": { + "schema": { + "title": "properties", + "type": "object", + "required": [], + "properties": { + "actions": { + "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_actions" + } + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "iap_accounts-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Account Schema", + "description": "This is the schema for an IAP account stored in Mongo", + "properties": { + "provenance": { + "title": "Provenance", + "description": "AAA provider where account originated", + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "title": "Username", + "description": "Username for account", + "type": "string", + "examples": ["john_doe"] + }, + "firstname": { + "title": "First Name", + "description": "The user's first name", + "type": "string", + "examples": ["John"] + }, + "memberOf": { + "title": "Assigned Groups", + "description": "Groups which this account is a part of", + "type": "array", + "items": { + "type": "object", + "properties": { + "aaaManaged": { + "description": "Whether group comes from an external AAA or not", + "type": "boolean" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "assignedRoles": { + "title": "Assigned Roles", + "description": "Roles assigned to this account", + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + }, + "additionalProperties": false + } + }, + "inactive": { + "title": "Inactive", + "description": "Setting for whether account is active or not", + "type": "boolean" + }, + "lastLogin": { + "title": "Last Login", + "description": "Date and time when the user last logged in", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "sso": { + "title": "sso", + "description": "Whether this is an SSO user", + "type": "boolean" + }, + "nameID": { + "title": "nameID", + "description": "Identifier for SSO account.", + "type": "string" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "title": "Created", + "description": "When the account was created", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updated": { + "title": "Updated", + "description": "When the account was last updated", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + } + } + }, + "email": { + "title": "Email", + "description": "Email for user", + "type": "string", + "examples": ["name@email.com"] + }, + "isServiceAccount": { + "description": "Value denoting if an account does not reflect a human user", + "type": "boolean" + }, + "loggedIn": { + "description": "Property used in the getAccounts API to indicate a user is currently logged in", + "type": "boolean" + }, + "gitTokens": { + "description": "Tokens used when interacting with Git APIs and features", + "type": "object", + "properties": { + "GitHub": { + "description": "Personal access token for GitHub", + "type": "string" + }, + "GitLab": { + "description": "Personal access token for GitLab", + "type": "string" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "provenance", + "username", + "firstname", + "memberOf", + "assignedRoles", + "inactive", + "gitTokens" + ] + }, + "iap_accounts-schema_username": { + "title": "Username", + "description": "Username for account", + "type": "string", + "examples": ["john_doe"] + }, + "iap_accounts-schema_inactive": { + "title": "Inactive", + "description": "Setting for whether account is active or not", + "type": "boolean" + }, + "iap_accounts-schema_memberOf": { + "title": "Assigned Groups", + "description": "Groups which this account is a part of", + "type": "array", + "items": { + "type": "object", + "properties": { + "aaaManaged": { + "description": "Whether group comes from an external AAA or not", + "type": "boolean" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "iap_accounts-schema_assignedRoles": { + "title": "Assigned Roles", + "description": "Roles assigned to this account", + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + }, + "additionalProperties": false + } + }, + "iap_accounts-schema_email": { + "title": "Email", + "description": "Email for user", + "type": "string", + "examples": ["name@email.com"] + }, + "iap_accounts-schema_isServiceAccount": { + "description": "Value denoting if an account does not reflect a human user", + "type": "boolean" + }, + "iap_accounts-schema_loggedIn": { + "description": "Property used in the getAccounts API to indicate a user is currently logged in", + "type": "boolean" + }, + "iap_accounts-schema_gitTokens": { + "description": "Tokens used when interacting with Git APIs and features", + "type": "object", + "properties": { + "GitHub": { + "description": "Personal access token for GitHub", + "type": "string" + }, + "GitLab": { + "description": "Personal access token for GitLab", + "type": "string" + } + }, + "additionalProperties": false + }, + "iap_common-schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "title": "Common schema definitions" + }, + "iap_common-schema_status": { + "type": "string", + "description": "The status of the API request.", + "enum": ["OK", "Created"] + }, + "iap_common-schema_message": { + "type": "string", + "description": "Message containing either confirmation of the operation or the reason for the failure of the operation.", + "examples": ["A sample success message"] + }, + "iap_common-schema_limit": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + }, + "iap_common-schema_skip": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + }, + "iap_common-schema_order": { + "type": "integer", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "default": 1, + "enum": [-1, 1] + }, + "iap_common-schema_sort": { + "type": "string", + "description": "Field to sort by. Default is name.", + "default": "name", + "enum": ["name"] + }, + "iap_common-schema_isActive": { + "type": "boolean", + "description": "Is profile the active profile.", + "examples": [true, false] + }, + "iap_common-schema_activeSync": { + "type": "boolean", + "description": "Is active profile in sync with the system.", + "examples": [true, false] + }, + "iap_common-schema_enabled": { + "type": "boolean", + "description": "A flag that denotes if the repository configuration is connected", + "enum": [true, false] + }, + "iap_common-schema_total": { + "type": "integer", + "description": "The total number of documents", + "minimum": 0, + "examples": [1, 5, 10, 20, 50] + }, + "iap_common-schema_type": { + "type": "string", + "description": "The type of Repository", + "enum": ["gitlab"] + }, + "iap_common-schema_hostname": { + "type": "string", + "description": "The hostname of the Respository endpoint", + "examples": ["gitlab.com"] + }, + "iap_common-schema_path": { + "type": "string", + "description": "The path of the Repository endpoint", + "examples": ["itentialopensource/pre-built-automations"] + }, + "iap_common-schema_credentials": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "An access token used to make HTTP requests", + "examples": ["uTc_P4pnMAEsLbQHmyOt"] + } + }, + "additionalProperties": false + }, + "iap_common-schema_config": { + "type": "string", + "description": "The name of the repository configuration that will be used to fetch Prebuilts", + "examples": ["@itentialopensource"] + }, + "iap_common-schema_objectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "iap_decorators-schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/redisProps/password"] + } + } + } + }, + "iap_indexes-schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "key": { + "type": "object", + "examples": [ + { + "name": 1 + } + ], + "additionalProperties": { + "type": "integer", + "enum": [-1, 1] + } + }, + "name": { + "type": "string", + "examples": ["name_1"] + }, + "background": { + "type": "boolean", + "enum": [true] + }, + "unique": { + "type": "boolean" + } + }, + "required": ["key", "background"] + }, + "iap_prebuilts-schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "@itentialopensource/aggregate-functions-for-arrays", + "@itentialopensource/cisco-nx-upgrade" + ] + }, + "version": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + }, + "description": { + "type": "string", + "examples": ["A basic description"] + }, + "author": { + "type": "string", + "examples": ["Itential Artifacts"] + }, + "license": { + "type": "string", + "examples": ["Apache-2.0"] + }, + "repository": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["local", "gitlab", "git"] + }, + "hostname": { + "type": "string", + "examples": ["gitlab.com", "localhost"] + }, + "path": { + "type": "string", + "examples": ["/itentialopensource/pre-built-automations"] + } + }, + "required": ["type"] + }, + "keywords": { + "type": "array", + "items": { + "type": "string", + "examples": ["Itential"] + } + }, + "IAPDependencies": { + "type": "object" + }, + "gitlabId": { + "type": "integer", + "examples": [17866482] + } + }, + "required": [ + "name", + "version", + "description", + "author", + "license", + "repository", + "IAPDependencies" + ], + "additionalProperties": false + }, + "manifest": { + "type": "object", + "properties": { + "bundleName": { + "type": "string", + "examples": ["aggregateFunctions"] + }, + "fingerprint": { + "type": "string", + "examples": ["5e84f892c5eab11ec2eee16d"] + }, + "createdEpoch": { + "type": "string", + "examples": ["1585772690392"] + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "examples": ["5e5ea3bd16da51d52b4a8f9f"] + }, + "name": { + "type": "string", + "examples": ["aggregateFunctions"] + }, + "type": { + "type": "string", + "enum": [ + "automation", + "forms", + "golden-config", + "integration", + "integration-model", + "json-forms", + "mop-template", + "mop-analytic-template", + "template", + "transformation", + "workflow" + ] + }, + "location": { + "type": "string", + "examples": [ + "/bundles/workflows/IAP Test Artifact Workflow.json" + ] + } + } + } + } + }, + "required": ["bundleName", "artifacts"], + "additionalProperties": false + }, + "bundles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "automation", + "forms", + "golden-config", + "integration", + "integration-model", + "json-forms", + "mop-template", + "mop-analytic-template", + "template", + "transformation", + "workflow" + ] + }, + "data": { + "type": "object" + } + }, + "required": ["type", "data"], + "additionalProperties": false + } + }, + "readme": { + "type": "string", + "examples": ["example of readme"], + "pattern": "^([\\S\\s]*)$" + } + }, + "required": ["metadata", "manifest", "bundles", "readme"], + "additionalProperties": false + }, + "iap_prebuilts-schema_readme": { + "type": "string", + "examples": ["example of readme"], + "pattern": "^([\\S\\s]*)$" + }, + "iap_prebuilts-schema_name": { + "type": "string", + "examples": [ + "@itentialopensource/aggregate-functions-for-arrays", + "@itentialopensource/cisco-nx-upgrade" + ] + }, + "iap_prebuilts-schema_version": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + }, + "iap_prebuilts-schema_description": { + "type": "string", + "examples": ["A basic description"] + }, + "iap_prebuilts-schema_author": { + "type": "string", + "examples": ["Itential Artifacts"] + }, + "iap_prebuilts-schema_license": { + "type": "string", + "examples": ["Apache-2.0"] + }, + "iap_prebuilts-schema_repository": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["local", "gitlab", "git"] + }, + "hostname": { + "type": "string", + "examples": ["gitlab.com", "localhost"] + }, + "path": { + "type": "string", + "examples": ["/itentialopensource/pre-built-automations"] + } + }, + "required": ["type"] + }, + "iap_prebuilts-schema_keywords": { + "type": "array", + "items": { + "type": "string", + "examples": ["Itential"] + } + }, + "iap_prebuilts-schema_IAPDependencies": { + "type": "object" + }, + "iap_profiles-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "The root schema", + "description": "The root schema comprises the entire JSON document.", + "properties": { + "uiProps": { + "type": "object", + "title": "UI Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["UI"] + }, + "layout": { + "type": "string", + "title": "Layout", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/layout.jade" + ] + }, + "home": { + "type": "string", + "title": "Home", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/home.jade" + ] + }, + "login": { + "type": "string", + "title": "Login", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/login.jade" + ] + }, + "profile": { + "type": "string", + "title": "Profile", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/profile.jade" + ] + }, + "fav_icon": { + "type": "string", + "title": "Favicon", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/img/favicon.ico" + ] + } + } + }, + "authenticationProps": { + "type": "object", + "title": "Authentication Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Authentication"] + }, + "logoutTime": { + "type": "integer", + "minimum": 2, + "description": "The maximum number of time IAP has to make an api call before the user is logged out, in minutes.", + "title": "Logout Time", + "examples": [20] + }, + "uniqueSession": { + "type": "boolean", + "description": "When uniqueSession is set to true, only one session may be enabled for a given user.", + "title": "Unique Session", + "examples": [false] + }, + "admins": { + "type": "array", + "title": "Admins", + "description": "Members of these groups will be implicitly assigned with admin permissions", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "description": "The name of the AAA adapter in which the groups reside.", + "title": "Provenance", + "examples": ["Local AAA"] + }, + "group": { + "type": "string", + "description": "The name of a user group which will have Pronghorn user management capabilities.", + "title": "Group", + "examples": ["admin"] + } + } + } + }, + "cookieName": { + "type": "string", + "description": "The name used by Pronghorn to identify cookies for user session data", + "title": "Cookie Name", + "examples": ["pronghorn_token"] + }, + "brokerPrincipal": { + "type": "boolean", + "description": "When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal.", + "title": "Broker Principal", + "examples": [false] + } + } + }, + "expressProps": { + "type": "object", + "title": "Express Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Express Server"] + }, + "cacheControl": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers.", + "title": "Cache Control", + "examples": [false] + }, + "timeout": { + "type": "integer", + "description": "The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client.", + "title": "Timeout", + "examples": [300000] + }, + "access_control_allow_origin": { + "type": "string", + "description": "The configured domain name for the Access-Control-Allow-Origin header used for security.", + "title": "Access-Control-Allow-Origin", + "examples": ["*"] + }, + "express_http": { + "type": "object", + "title": "Express HTTP Settings", + "properties": { + "enable": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests.", + "title": "Enable HTTP", + "examples": [false] + }, + "port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + } + } + }, + "express_https": { + "type": "object", + "title": "Express HTTPS Settings", + "properties": { + "enable": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests.", + "title": "Enable HTTPS", + "examples": [true] + }, + "port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + }, + "key": { + "type": "string", + "description": "The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property.", + "title": "Key", + "examples": ["/opt/pronghorn/current/keys/key.pem"] + }, + "passphrase": { + "type": "string", + "title": "Passphrase", + "description": "The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase." + }, + "cert": { + "type": "string", + "title": "Certificate", + "description": "The server's public certificate to use for all HTTPS transactions.", + "examples": ["/opt/pronghorn/current/keys/cert.pem"] + }, + "secureProtocol": { + "type": "string", + "description": "The secureProtocol can be used to configure the set of allowed SSL/TLS protocol versions.", + "title": "Secure Protocol", + "examples": ["TLSv1_2_method"], + "enum": ["TLSv1_method", "TLSv1_1_method", "TLSv1_2_method"] + }, + "ciphers": { + "type": "string", + "description": "The set of ciphers to allow when establishing an encrypted session.", + "title": "Ciphers", + "examples": [ + "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" + ] + }, + "client_reneg_limit": { + "type": "integer", + "description": "The maximum number of client renegotiations allowed per renegotiation window.", + "title": "Client Renegotiation Limit", + "examples": [1] + }, + "client_reneg_window": { + "type": "integer", + "description": "The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds.", + "title": "Client Renegotiation Window", + "examples": [600] + } + } + }, + "allowedHttpOptionalVerbs": { + "title": "Allowed HTTP Optional Verbs", + "description": "An array of optional HTTP verbs that are allowed to be used in requests to IAP", + "type": "array", + "uniqueItems": true, + "items": { + "enum": [ + "ACL", + "BIND", + "CHECKOUT", + "CONNECT", + "COPY", + "LINK", + "LOCK", + "MERGE", + "MKACTIVITY", + "MKCALENDAR", + "MKCOL", + "MOVE", + "M-SEARCH", + "NOTIFY", + "PROPFIND", + "PROPPATCH", + "PURGE", + "REBIND", + "REPORT", + "SEARCH", + "SUBSCRIBE", + "TRACE", + "UNBIND", + "UNLINK", + "UNLOCK", + "UNSUBSCRIBE" + ] + } + } + } + }, + "loggerProps": { + "type": "object", + "title": "Logger Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Logging"] + }, + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store Pronghorn log files.", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name of the current Pronghorn log file.", + "title": "Filename", + "examples": ["pronghorn.log"] + }, + "log_max_file_size": { + "type": "integer", + "title": "Max File Size", + "description": "The maximum size of each Pronghorn log file in bytes.", + "examples": [1048576] + }, + "log_max_files": { + "type": "integer", + "description": "The maximum number of log files maintained on the server.", + "title": "Max Number of Files", + "examples": [100] + }, + "log_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "console_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "webserver": { + "type": "object", + "description": "Determines how to set up the web server access log.", + "title": "Webserver", + "properties": { + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store web server access log files.", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name for the web server access log file.", + "title": "Filename", + "examples": ["webserver.log"] + } + } + }, + "syslog": { + "type": "object", + "description": "Allows Pronghorn to send log messages to a local or remote syslog daemon.", + "title": "Syslog", + "properties": { + "level": { + "type": "string", + "title": "Sys Log Level", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "host": { + "type": "string", + "description": "The host running syslogd.", + "title": "Host", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "description": "The port on the host that syslog is running on.", + "title": "Port", + "minimum": 1, + "maximum": 65535, + "examples": [514] + }, + "protocol": { + "type": "string", + "title": "Protocol", + "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", + "examples": ["udp4"], + "enum": ["tcp4", "udp4", "unix", "unix-connect"] + }, + "facility": { + "type": "string", + "description": "The syslog facility to use.", + "title": "Facility", + "examples": ["local0"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", + "examples": ["5424"], + "enum": ["BSD", "5424"] + }, + "path": { + "type": "string", + "title": "Path", + "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured.", + "format": "uri-reference", + "examples": ["/dev/log"] + }, + "pid": { + "type": "string", + "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", + "title": "Process ID", + "examples": ["process.pid"] + }, + "localhost": { + "type": "string", + "description": "The host to indicate that log messages are coming from.", + "title": "Log Host", + "examples": ["localhost"] + }, + "app_name": { + "type": "string", + "description": "The name of the application.", + "title": "Application Name", + "examples": ["process.title"] + }, + "eol": { + "type": "string", + "title": "End of Line Character", + "description": "The end of line character to be added to the end of the message.", + "examples": ["CR"] + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + }, + "redisProps": { + "type": "object", + "title": "Redis Properties", + "properties": { + "db": { + "type": "integer", + "description": "The Redis database number to connect to (may be any of 0-15).", + "title": "Database Number", + "examples": [0], + "minimum": 0 + }, + "username": { + "type": "string", + "title": "Username", + "description": "The username with access to the Redis DB.", + "examples": ["admin"] + }, + "password": { + "type": "string", + "title": "Password", + "description": "The passphrase protecting access to the Redis DB.", + "examples": [ + "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e" + ] + }, + "maxRetriesPerRequest": { + "type": "integer", + "description": "IAP will be shutdown after maxRetriesPerRequest is reached in case of lost Redis network connection.", + "title": "Max Retries Per Request", + "examples": [20] + }, + "maxHeartbeatWriteRetries": { + "type": "integer", + "description": "IAP will be shutdown after maxHeartbeatWriteRetries is reached in case of lost ability to write data in Redis.", + "title": "Max Heartbeat Write Retries", + "examples": [20] + } + }, + "oneOf": [ + { + "properties": { + "host": { + "type": "string", + "description": "The IP or hostname of the server running the Redis service.", + "title": "Host", + "examples": ["127.0.0.1", "localhost", "::1"] + }, + "port": { + "type": "integer", + "title": "Port", + "examples": [6379] + } + }, + "required": ["host", "port"] + }, + { + "properties": { + "sentinels": { + "type": "array", + "title": "Sentinels", + "items": { + "type": "object", + "properties": { + "host": { + "type": "string", + "title": "Host", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "title": "Port", + "examples": [26379] + } + } + }, + "description": "The list of Redis hosts for sentinel configuration." + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the master node in the Redis sentinel group." + } + }, + "required": ["sentinels", "name"] + } + ] + }, + "auditProps": { + "type": "object", + "title": "Audit Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Audit"] + }, + "audit": { + "type": "boolean", + "title": "Audit", + "examples": [true] + }, + "brokerValidation": { + "type": "boolean", + "title": "Broker Validation", + "examples": [true] + } + } + }, + "pathProps": { + "type": "object", + "title": "Path Properties", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "encrypted": { + "type": "boolean", + "description": "A boolean flag indicating Pronghorn core is encrypted.", + "title": "Encrypted", + "examples": [true] + } + } + }, + "alarmProps": { + "title": "Alarm Properties", + "type": "array", + "items": { + "type": "object", + "title": "Remote SNMP Config", + "description": "Remote SNMP destination config.", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "ip": { + "type": "string", + "format": "hostname", + "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", + "title": "Remote Server IP Address", + "examples": ["127.0.0.1"] + }, + "community": { + "type": "string", + "description": "The SNMP community to apply to the outgoing trap or inform.", + "title": "SNMP Community", + "examples": ["public"] + }, + "properties": { + "type": "object", + "properties": { + "retries": { + "type": "integer", + "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", + "title": "Retries", + "examples": [1] + }, + "timeout": { + "type": "integer", + "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", + "title": "Timeout", + "examples": [5000] + }, + "transport": { + "type": "string", + "description": "The protocol to use to send alarms to this receiver.", + "title": "Transport Protocol", + "examples": ["udp4"], + "enum": ["udp4", "udp6"] + }, + "trapPort": { + "type": "integer", + "description": "The remote port of this alarm receiver.", + "title": "SNMP Trap Port", + "examples": [162] + }, + "version": { + "type": "string", + "description": "The SNMP version to use when delivering notifications to this alarm receiver.", + "title": "SNMP Version", + "examples": ["V1"], + "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] + } + } + }, + "type": { + "type": "string", + "description": "The type can be configured as either a trap or inform.", + "title": "SNMP Type", + "examples": ["trap", "inform"], + "enum": ["trap", "inform"] + } + }, + "additionalProperties": false + }, + "minItems": 0 + }, + "id": { + "type": "string", + "title": "Profile ID", + "pattern": "^[^\\/]+$", + "examples": ["profile1"] + }, + "services": { + "type": "array", + "title": "Services", + "items": { + "type": "string", + "examples": ["WorkflowBuilder", "FormBuilder"] + } + }, + "description": { + "type": "string", + "title": "Description", + "examples": ["An IAP Profile"] + }, + "adapterStrategy": { + "type": "object", + "title": "Adapter Strategy", + "properties": { + "device": { + "title": "Device Calls", + "description": "Defines the order in which southbound systems are called.", + "properties": { + "adapterTypes": { + "type": "array", + "uniqueItems": true, + "title": "Adapter Types", + "description": "A list of adapter types that manages the devices.", + "items": { + "type": "string", + "enum": ["NSO", "AutomationGateway"] + } + }, + "exceptions": { + "type": "object", + "maxProperties": 1, + "title": "Exceptions", + "description": "An override for the runCommand's preference to a southbound system.", + "properties": { + "runCommand": { + "type": "string", + "title": "Run Command", + "description": "Runs a command on a device.", + "oneOf": [ + { + "const": "", + "title": "None" + }, + { + "const": "NSO", + "title": "NSO" + }, + { + "const": "AutomationGateway", + "title": "Automation Gateway" + } + ] + } + } + } + }, + "type": "object" + } + }, + "additionalProperties": true + }, + "systemProps": { + "type": "object", + "title": "System Properties", + "description": "Properties used to configure IAP process.", + "properties": { + "shutdownTimeout": { + "type": "integer", + "title": "Shutdown Timeout", + "minimum": 0, + "description": "The amount of time a service should wait before shutting down, in seconds.", + "examples": [3] + }, + "servicesBlacklist": { + "type": "array", + "title": "Services Blacklist", + "description": "An array of services that blocks CRUD operation access for each service listed.", + "items": { + "type": "string", + "description": "The service type that will be denied CRUD operation access.", + "examples": ["Local AAA"] + } + }, + "launchDelay": { + "type": "integer", + "title": "Launch Delay", + "minimum": 0, + "maximum": 60, + "description": "The application/adapter launch delay, in seconds.", + "examples": [5] + }, + "launchTimeout": { + "type": "integer", + "title": "Launch Timeout", + "minimum": 30, + "maximum": 1200, + "description": "The application/adapter launch timeout, in seconds.", + "examples": [60] + }, + "serviceHealthCheckInterval": { + "type": "integer", + "title": "Service Health Check Interval", + "minimum": 1, + "description": "How often to update service health, measured in seconds." + }, + "serviceHealthCheckUnhealthyThreshold": { + "type": "integer", + "title": "Service Health Check Unhealthy Threshold", + "minimum": 1, + "description": "Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline." + }, + "deadProcessCheck": { + "type": "boolean", + "title": "Dead Process Check", + "description": "Enable/disable IAP check for dead applications/adapters.", + "examples": [false, true] + }, + "deadProcessCheckInterval": { + "type": "integer", + "title": "Dead Process Check Interval", + "minimum": 5, + "maximum": 600, + "description": "How often to check if application/adapter stopped sending healthcheck pings, in seconds.", + "examples": [5] + }, + "deadProcessMaxPeriod": { + "type": "integer", + "title": "Dead Process Max Period", + "minimum": 15, + "maximum": 600, + "description": "Maximum time period for application/adapter without sending healthcheck ping, in seconds.", + "examples": [15] + }, + "externalRequestTimeout": { + "type": "integer", + "title": "External Request Timeout", + "minimum": 1, + "maximum": 120, + "description": "The timeout for external API requests, in seconds.", + "examples": [5, 10] + }, + "deviceCountPollingInterval": { + "type": "integer", + "title": "Device Count Polling Interval", + "minimum": 1, + "maximum": 168, + "description": "The interval for how often IAP polls for the number of devices, in hours.", + "examples": [24] + } + } + }, + "prebuiltProps": { + "type": "object", + "title": "Prebuilt Properties", + "properties": { + "repoConfigs": { + "type": "object", + "title": "Repository Configurations", + "description": "The configurations used to fetch Prebuilts from different repositories.", + "properties": { + "@itentialopensource": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "A flag that denotes if the repository configuration is connected", + "enum": [true, false] + }, + "type": { + "type": "string", + "description": "The type of Repository", + "enum": ["gitlab"] + }, + "hostname": { + "type": "string", + "description": "The hostname of the Respository endpoint", + "examples": ["gitlab.com"] + }, + "path": { + "type": "string", + "description": "The path of the Repository endpoint", + "examples": ["itentialopensource/pre-built-automations"] + }, + "credentials": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "An access token used to make HTTP requests", + "examples": ["uTc_P4pnMAEsLbQHmyOt"] + } + }, + "additionalProperties": false + } + } + } + }, + "additionalProperties": true + } + } + }, + "integrationProps": { + "type": "object", + "title": "Integration Properties", + "properties": { + "threadCount": { + "type": "integer", + "title": "Integrations Thread Count", + "minimum": 1, + "maximum": 16, + "description": "The number of threads available for API requests.", + "examples": [5] + }, + "timeout": { + "type": "integer", + "title": "Integrations Timeout", + "description": "The number of milliseconds until an integration request times out.", + "examples": [15000] + } + } + }, + "retryStrategy": { + "type": "object", + "title": "Retry Strategy", + "description": "Properties used to configure the strategy services use on crash.", + "properties": { + "maxRetries": { + "type": "integer", + "title": "Max Retries", + "minimum": 1, + "description": "Specifies the amount of times services will retry on crash before stopping.", + "examples": [5] + }, + "retryResetTimer": { + "type": "integer", + "title": "Retry Reset Timer", + "minimum": 0, + "description": "Specifies the amount of times between each retry before the count will reset in milliseconds.", + "examples": [30000] + } + } + }, + "serviceDirectory": { + "type": "string", + "title": "Service Directory", + "description": "Directory at which to find additional services." + } + }, + "additionalProperties": true + }, + "iap_profiles-schema_snmpConfig": { + "type": "object", + "title": "Remote SNMP Config", + "description": "Remote SNMP destination config.", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "ip": { + "type": "string", + "format": "hostname", + "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", + "title": "Remote Server IP Address", + "examples": ["127.0.0.1"] + }, + "community": { + "type": "string", + "description": "The SNMP community to apply to the outgoing trap or inform.", + "title": "SNMP Community", + "examples": ["public"] + }, + "properties": { + "type": "object", + "properties": { + "retries": { + "type": "integer", + "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", + "title": "Retries", + "examples": [1] + }, + "timeout": { + "type": "integer", + "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", + "title": "Timeout", + "examples": [5000] + }, + "transport": { + "type": "string", + "description": "The protocol to use to send alarms to this receiver.", + "title": "Transport Protocol", + "examples": ["udp4"], + "enum": ["udp4", "udp6"] + }, + "trapPort": { + "type": "integer", + "description": "The remote port of this alarm receiver.", + "title": "SNMP Trap Port", + "examples": [162] + }, + "version": { + "type": "string", + "description": "The SNMP version to use when delivering notifications to this alarm receiver.", + "title": "SNMP Version", + "examples": ["V1"], + "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] + } + } + }, + "type": { + "type": "string", + "description": "The type can be configured as either a trap or inform.", + "title": "SNMP Type", + "examples": ["trap", "inform"], + "enum": ["trap", "inform"] + } + }, + "additionalProperties": false + }, + "iap_profiles-schema_log_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "iap_profiles-schema_sys_log_level": { + "type": "string", + "title": "Sys Log Level", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "iap_profiles-schema_port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + }, + "iap_profiles-schema_uiProps": { + "type": "object", + "title": "UI Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["UI"] + }, + "layout": { + "type": "string", + "title": "Layout", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/layout.jade" + ] + }, + "home": { + "type": "string", + "title": "Home", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/home.jade" + ] + }, + "login": { + "type": "string", + "title": "Login", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/login.jade" + ] + }, + "profile": { + "type": "string", + "title": "Profile", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/views/profile.jade" + ] + }, + "fav_icon": { + "type": "string", + "title": "Favicon", + "examples": [ + "node_modules/@itential/pronghorn-core/ui/img/favicon.ico" + ] + } + } + }, + "iap_profiles-schema_authenticationProps": { + "type": "object", + "title": "Authentication Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Authentication"] + }, + "logoutTime": { + "type": "integer", + "minimum": 2, + "description": "The maximum number of time IAP has to make an api call before the user is logged out, in minutes.", + "title": "Logout Time", + "examples": [20] + }, + "uniqueSession": { + "type": "boolean", + "description": "When uniqueSession is set to true, only one session may be enabled for a given user.", + "title": "Unique Session", + "examples": [false] + }, + "admins": { + "type": "array", + "title": "Admins", + "description": "Members of these groups will be implicitly assigned with admin permissions", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "description": "The name of the AAA adapter in which the groups reside.", + "title": "Provenance", + "examples": ["Local AAA"] + }, + "group": { + "type": "string", + "description": "The name of a user group which will have Pronghorn user management capabilities.", + "title": "Group", + "examples": ["admin"] + } + } + } + }, + "cookieName": { + "type": "string", + "description": "The name used by Pronghorn to identify cookies for user session data", + "title": "Cookie Name", + "examples": ["pronghorn_token"] + }, + "brokerPrincipal": { + "type": "boolean", + "description": "When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal.", + "title": "Broker Principal", + "examples": [false] + } + } + }, + "iap_profiles-schema_expressProps": { + "type": "object", + "title": "Express Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Express Server"] + }, + "cacheControl": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers.", + "title": "Cache Control", + "examples": [false] + }, + "timeout": { + "type": "integer", + "description": "The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client.", + "title": "Timeout", + "examples": [300000] + }, + "access_control_allow_origin": { + "type": "string", + "description": "The configured domain name for the Access-Control-Allow-Origin header used for security.", + "title": "Access-Control-Allow-Origin", + "examples": ["*"] + }, + "express_http": { + "type": "object", + "title": "Express HTTP Settings", + "properties": { + "enable": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests.", + "title": "Enable HTTP", + "examples": [false] + }, + "port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + } + } + }, + "express_https": { + "type": "object", + "title": "Express HTTPS Settings", + "properties": { + "enable": { + "type": "boolean", + "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests.", + "title": "Enable HTTPS", + "examples": [true] + }, + "port": { + "type": "integer", + "title": "Port", + "minimum": 1, + "maximum": 65535 + }, + "key": { + "type": "string", + "description": "The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property.", + "title": "Key", + "examples": ["/opt/pronghorn/current/keys/key.pem"] + }, + "passphrase": { + "type": "string", + "title": "Passphrase", + "description": "The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase." + }, + "cert": { + "type": "string", + "title": "Certificate", + "description": "The server's public certificate to use for all HTTPS transactions.", + "examples": ["/opt/pronghorn/current/keys/cert.pem"] + }, + "secureProtocol": { + "type": "string", + "description": "The secureProtocol can be used to configure the set of allowed SSL/TLS protocol versions.", + "title": "Secure Protocol", + "examples": ["TLSv1_2_method"], + "enum": ["TLSv1_method", "TLSv1_1_method", "TLSv1_2_method"] + }, + "ciphers": { + "type": "string", + "description": "The set of ciphers to allow when establishing an encrypted session.", + "title": "Ciphers", + "examples": [ + "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" + ] + }, + "client_reneg_limit": { + "type": "integer", + "description": "The maximum number of client renegotiations allowed per renegotiation window.", + "title": "Client Renegotiation Limit", + "examples": [1] + }, + "client_reneg_window": { + "type": "integer", + "description": "The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds.", + "title": "Client Renegotiation Window", + "examples": [600] + } + } + }, + "allowedHttpOptionalVerbs": { + "title": "Allowed HTTP Optional Verbs", + "description": "An array of optional HTTP verbs that are allowed to be used in requests to IAP", + "type": "array", + "uniqueItems": true, + "items": { + "enum": [ + "ACL", + "BIND", + "CHECKOUT", + "CONNECT", + "COPY", + "LINK", + "LOCK", + "MERGE", + "MKACTIVITY", + "MKCALENDAR", + "MKCOL", + "MOVE", + "M-SEARCH", + "NOTIFY", + "PROPFIND", + "PROPPATCH", + "PURGE", + "REBIND", + "REPORT", + "SEARCH", + "SUBSCRIBE", + "TRACE", + "UNBIND", + "UNLINK", + "UNLOCK", + "UNSUBSCRIBE" + ] + } + } + } + }, + "iap_profiles-schema_loggerProps": { + "type": "object", + "title": "Logger Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Logging"] + }, + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store Pronghorn log files.", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name of the current Pronghorn log file.", + "title": "Filename", + "examples": ["pronghorn.log"] + }, + "log_max_file_size": { + "type": "integer", + "title": "Max File Size", + "description": "The maximum size of each Pronghorn log file in bytes.", + "examples": [1048576] + }, + "log_max_files": { + "type": "integer", + "description": "The maximum number of log files maintained on the server.", + "title": "Max Number of Files", + "examples": [100] + }, + "log_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "console_level": { + "type": "string", + "title": "Log Level", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "webserver": { + "type": "object", + "description": "Determines how to set up the web server access log.", + "title": "Webserver", + "properties": { + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store web server access log files.", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name for the web server access log file.", + "title": "Filename", + "examples": ["webserver.log"] + } + } + }, + "syslog": { + "type": "object", + "description": "Allows Pronghorn to send log messages to a local or remote syslog daemon.", + "title": "Syslog", + "properties": { + "level": { + "type": "string", + "title": "Sys Log Level", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "host": { + "type": "string", + "description": "The host running syslogd.", + "title": "Host", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "description": "The port on the host that syslog is running on.", + "title": "Port", + "minimum": 1, + "maximum": 65535, + "examples": [514] + }, + "protocol": { + "type": "string", + "title": "Protocol", + "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", + "examples": ["udp4"], + "enum": ["tcp4", "udp4", "unix", "unix-connect"] + }, + "facility": { + "type": "string", + "description": "The syslog facility to use.", + "title": "Facility", + "examples": ["local0"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", + "examples": ["5424"], + "enum": ["BSD", "5424"] + }, + "path": { + "type": "string", + "title": "Path", + "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured.", + "format": "uri-reference", + "examples": ["/dev/log"] + }, + "pid": { + "type": "string", + "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", + "title": "Process ID", + "examples": ["process.pid"] + }, + "localhost": { + "type": "string", + "description": "The host to indicate that log messages are coming from.", + "title": "Log Host", + "examples": ["localhost"] + }, + "app_name": { + "type": "string", + "description": "The name of the application.", + "title": "Application Name", + "examples": ["process.title"] + }, + "eol": { + "type": "string", + "title": "End of Line Character", + "description": "The end of line character to be added to the end of the message.", + "examples": ["CR"] + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + }, + "iap_profiles-schema_redisProps": { + "type": "object", + "title": "Redis Properties", + "properties": { + "db": { + "type": "integer", + "description": "The Redis database number to connect to (may be any of 0-15).", + "title": "Database Number", + "examples": [0], + "minimum": 0 + }, + "username": { + "type": "string", + "title": "Username", + "description": "The username with access to the Redis DB.", + "examples": ["admin"] + }, + "password": { + "type": "string", + "title": "Password", + "description": "The passphrase protecting access to the Redis DB.", + "examples": ["$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e"] + }, + "maxRetriesPerRequest": { + "type": "integer", + "description": "IAP will be shutdown after maxRetriesPerRequest is reached in case of lost Redis network connection.", + "title": "Max Retries Per Request", + "examples": [20] + }, + "maxHeartbeatWriteRetries": { + "type": "integer", + "description": "IAP will be shutdown after maxHeartbeatWriteRetries is reached in case of lost ability to write data in Redis.", + "title": "Max Heartbeat Write Retries", + "examples": [20] + } + }, + "oneOf": [ + { + "properties": { + "host": { + "type": "string", + "description": "The IP or hostname of the server running the Redis service.", + "title": "Host", + "examples": ["127.0.0.1", "localhost", "::1"] + }, + "port": { + "type": "integer", + "title": "Port", + "examples": [6379] + } + }, + "required": ["host", "port"] + }, + { + "properties": { + "sentinels": { + "type": "array", + "title": "Sentinels", + "items": { + "type": "object", + "properties": { + "host": { + "type": "string", + "title": "Host", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "title": "Port", + "examples": [26379] + } + } + }, + "description": "The list of Redis hosts for sentinel configuration." + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the master node in the Redis sentinel group." + } + }, + "required": ["sentinels", "name"] + } + ] + }, + "iap_profiles-schema_auditProps": { + "type": "object", + "title": "Audit Properties", + "properties": { + "description": { + "type": "string", + "title": "Description", + "examples": ["Audit"] + }, + "audit": { + "type": "boolean", + "title": "Audit", + "examples": [true] + }, + "brokerValidation": { + "type": "boolean", + "title": "Broker Validation", + "examples": [true] + } + } + }, + "iap_profiles-schema_pathProps": { + "type": "object", + "title": "Path Properties", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "encrypted": { + "type": "boolean", + "description": "A boolean flag indicating Pronghorn core is encrypted.", + "title": "Encrypted", + "examples": [true] + } + } + }, + "iap_profiles-schema_alarmProps": { + "title": "Alarm Properties", + "type": "array", + "items": { + "type": "object", + "title": "Remote SNMP Config", + "description": "Remote SNMP destination config.", + "properties": { + "description": { + "title": "Description", + "type": "string" + }, + "ip": { + "type": "string", + "format": "hostname", + "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", + "title": "Remote Server IP Address", + "examples": ["127.0.0.1"] + }, + "community": { + "type": "string", + "description": "The SNMP community to apply to the outgoing trap or inform.", + "title": "SNMP Community", + "examples": ["public"] + }, + "properties": { + "type": "object", + "properties": { + "retries": { + "type": "integer", + "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", + "title": "Retries", + "examples": [1] + }, + "timeout": { + "type": "integer", + "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", + "title": "Timeout", + "examples": [5000] + }, + "transport": { + "type": "string", + "description": "The protocol to use to send alarms to this receiver.", + "title": "Transport Protocol", + "examples": ["udp4"], + "enum": ["udp4", "udp6"] + }, + "trapPort": { + "type": "integer", + "description": "The remote port of this alarm receiver.", + "title": "SNMP Trap Port", + "examples": [162] + }, + "version": { + "type": "string", + "description": "The SNMP version to use when delivering notifications to this alarm receiver.", + "title": "SNMP Version", + "examples": ["V1"], + "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] + } + } + }, + "type": { + "type": "string", + "description": "The type can be configured as either a trap or inform.", + "title": "SNMP Type", + "examples": ["trap", "inform"], + "enum": ["trap", "inform"] + } + }, + "additionalProperties": false + }, + "minItems": 0 + }, + "iap_profiles-schema_id": { + "type": "string", + "title": "Profile ID", + "pattern": "^[^\\/]+$", + "examples": ["profile1"] + }, + "iap_profiles-schema_services": { + "type": "array", + "title": "Services", + "items": { + "type": "string", + "examples": ["WorkflowBuilder", "FormBuilder"] + } + }, + "iap_profiles-schema_description": { + "type": "string", + "title": "Description", + "examples": ["An IAP Profile"] + }, + "iap_profiles-schema_adapterStrategy": { + "type": "object", + "title": "Adapter Strategy", + "properties": { + "device": { + "title": "Device Calls", + "description": "Defines the order in which southbound systems are called.", + "properties": { + "adapterTypes": { + "type": "array", + "uniqueItems": true, + "title": "Adapter Types", + "description": "A list of adapter types that manages the devices.", + "items": { + "type": "string", + "enum": ["NSO", "AutomationGateway"] + } + }, + "exceptions": { + "type": "object", + "maxProperties": 1, + "title": "Exceptions", + "description": "An override for the runCommand's preference to a southbound system.", + "properties": { + "runCommand": { + "type": "string", + "title": "Run Command", + "description": "Runs a command on a device.", + "oneOf": [ + { + "const": "", + "title": "None" + }, + { + "const": "NSO", + "title": "NSO" + }, + { + "const": "AutomationGateway", + "title": "Automation Gateway" + } + ] + } + } + } + }, + "type": "object" + } + }, + "additionalProperties": true + }, + "iap_profiles-schema_systemProps": { + "type": "object", + "title": "System Properties", + "description": "Properties used to configure IAP process.", + "properties": { + "shutdownTimeout": { + "type": "integer", + "title": "Shutdown Timeout", + "minimum": 0, + "description": "The amount of time a service should wait before shutting down, in seconds.", + "examples": [3] + }, + "servicesBlacklist": { + "type": "array", + "title": "Services Blacklist", + "description": "An array of services that blocks CRUD operation access for each service listed.", + "items": { + "type": "string", + "description": "The service type that will be denied CRUD operation access.", + "examples": ["Local AAA"] + } + }, + "launchDelay": { + "type": "integer", + "title": "Launch Delay", + "minimum": 0, + "maximum": 60, + "description": "The application/adapter launch delay, in seconds.", + "examples": [5] + }, + "launchTimeout": { + "type": "integer", + "title": "Launch Timeout", + "minimum": 30, + "maximum": 1200, + "description": "The application/adapter launch timeout, in seconds.", + "examples": [60] + }, + "serviceHealthCheckInterval": { + "type": "integer", + "title": "Service Health Check Interval", + "minimum": 1, + "description": "How often to update service health, measured in seconds." + }, + "serviceHealthCheckUnhealthyThreshold": { + "type": "integer", + "title": "Service Health Check Unhealthy Threshold", + "minimum": 1, + "description": "Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline." + }, + "deadProcessCheck": { + "type": "boolean", + "title": "Dead Process Check", + "description": "Enable/disable IAP check for dead applications/adapters.", + "examples": [false, true] + }, + "deadProcessCheckInterval": { + "type": "integer", + "title": "Dead Process Check Interval", + "minimum": 5, + "maximum": 600, + "description": "How often to check if application/adapter stopped sending healthcheck pings, in seconds.", + "examples": [5] + }, + "deadProcessMaxPeriod": { + "type": "integer", + "title": "Dead Process Max Period", + "minimum": 15, + "maximum": 600, + "description": "Maximum time period for application/adapter without sending healthcheck ping, in seconds.", + "examples": [15] + }, + "externalRequestTimeout": { + "type": "integer", + "title": "External Request Timeout", + "minimum": 1, + "maximum": 120, + "description": "The timeout for external API requests, in seconds.", + "examples": [5, 10] + }, + "deviceCountPollingInterval": { + "type": "integer", + "title": "Device Count Polling Interval", + "minimum": 1, + "maximum": 168, + "description": "The interval for how often IAP polls for the number of devices, in hours.", + "examples": [24] + } + } + }, + "iap_profiles-schema_integrationProps": { + "type": "object", + "title": "Integration Properties", + "properties": { + "threadCount": { + "type": "integer", + "title": "Integrations Thread Count", + "minimum": 1, + "maximum": 16, + "description": "The number of threads available for API requests.", + "examples": [5] + }, + "timeout": { + "type": "integer", + "title": "Integrations Timeout", + "description": "The number of milliseconds until an integration request times out.", + "examples": [15000] + } + } + }, + "iap_profiles-schema_retryStrategy": { + "type": "object", + "title": "Retry Strategy", + "description": "Properties used to configure the strategy services use on crash.", + "properties": { + "maxRetries": { + "type": "integer", + "title": "Max Retries", + "minimum": 1, + "description": "Specifies the amount of times services will retry on crash before stopping.", + "examples": [5] + }, + "retryResetTimer": { + "type": "integer", + "title": "Retry Reset Timer", + "minimum": 0, + "description": "Specifies the amount of times between each retry before the count will reset in milliseconds.", + "examples": [30000] + } + } + }, + "iap_profiles-schema_serviceDirectory": { + "type": "string", + "title": "Service Directory", + "description": "Directory at which to find additional services." + }, + "iap_services-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Services Schema", + "description": "All of the properties required for a service.", + "properties": { + "loggerProps": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description property", + "title": "Description", + "default": "Logger Settings", + "examples": ["Logging"] + }, + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store Pronghorn log files.", + "default": "/var/log/pronghorn", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name of the current Pronghorn log file.", + "title": "Filename", + "default": "pronghorn.log", + "examples": ["pronghorn.log"] + }, + "log_max_file_size": { + "type": "integer", + "title": "Max File Size", + "description": "The maximum size of each Pronghorn log file in bytes.", + "default": 1048576, + "examples": [1048576] + }, + "log_max_files": { + "type": "integer", + "description": "The maximum number of log files maintained on the server.", + "title": "Max Number of Files", + "default": 100, + "examples": [100] + }, + "log_timezone_offset": { + "type": "integer", + "description": "An integer specifying the offset from GMT/UTC time that will be used when writing to the log files.", + "title": "Timezone Offset", + "default": 0, + "examples": [-5], + "minimum": -12, + "maximum": 12 + }, + "log_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "console_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "metrics_filename": { + "type": "string", + "description": "The name of the job metrics log file, if applicable.", + "title": "Metrics Filename", + "default": "metrics.log", + "examples": ["metrics.log"] + }, + "metrics_max_files": { + "type": "integer", + "description": "The maximum number of job metrics log files maintained on the server, if applicable.", + "title": "Max Number of Metrics Files", + "default": 31, + "examples": [31] + }, + "metrics_rotation_interval": { + "type": "string", + "description": "The time until the metrics log is rotated in minutes, hours, days, or weeks, if applicable.", + "title": "Rotation Interval of Metrics Files", + "default": "7d", + "examples": ["7d"] + }, + "metrics_rotation_size": { + "type": "string", + "description": "The maximum file size before the metrics log is rotated in kilobytes, megabytes, or gigabytes, if applicable.", + "title": "Rotation Size of Metrics Files", + "default": "10M", + "examples": ["10M"] + }, + "syslog": { + "type": "object", + "description": "The syslog properties allow Pronghorn to send log messages to a local or remote syslog daemon.", + "properties": { + "level": { + "type": "string", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "host": { + "type": "string", + "description": "The host running syslogd.", + "title": "Host", + "default": "localhost", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "description": "The port on the host that syslog is running on.", + "title": "Port", + "default": 514, + "minimum": 1, + "maximum": 65535, + "examples": [514] + }, + "protocol": { + "type": "string", + "title": "Protocol", + "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", + "default": "udp4", + "examples": ["udp4"], + "enum": ["tcp4", "udp4", "unix", "unix-connect"] + }, + "facility": { + "type": "string", + "description": "Syslog facility to use.", + "title": "Facility", + "default": "local0", + "examples": ["local0"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", + "default": "BSD", + "examples": ["5424"], + "enum": ["BSD", "5424"] + }, + "path": { + "type": "string", + "title": "Path", + "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X).If path is used, host, port and protocol do not need to be configured.", + "default": "", + "format": "uri-reference", + "examples": ["/dev/log"] + }, + "pid": { + "type": "string", + "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", + "title": "Process Id", + "default": "process.pid", + "examples": ["process.pid"] + }, + "localhost": { + "type": "string", + "description": "Host to indicate that log messages are coming from.", + "title": "Log Host", + "default": "", + "examples": ["localhost"] + }, + "app_name": { + "type": "string", + "description": "The name of the application.", + "title": "Application Name", + "default": "", + "examples": ["process.title"] + }, + "eol": { + "type": "string", + "title": "End of Line Character", + "description": "The end of line character to be added to the end of the message.", + "default": "", + "examples": ["CR"] + } + }, + "allOf": [ + { + "required": ["level", "facility", "type"] + }, + { + "anyOf": [ + { + "required": ["host", "port", "protocol"] + }, + { + "required": ["path"] + } + ] + } + ], + "additionalProperties": false + } + }, + "required": [ + "log_max_files", + "log_max_file_size", + "log_level", + "log_directory", + "log_filename", + "console_level" + ], + "additionalProperties": false + }, + "isEncrypted": { + "type": "boolean", + "title": "isEncrypted", + "default": false, + "description": "Whether or not this service is encrypted", + "examples": [true, false] + }, + "profiling": { + "type": "boolean", + "title": "profiling", + "default": false, + "description": "Whether or not to profile this service", + "examples": [true, false] + }, + "model": { + "type": "string", + "title": "Model", + "default": "", + "description": "The model used by the service", + "examples": ["@itential/adapter-local_aaa"], + "pattern": "^@[-_.a-z]+/.+" + }, + "name": { + "type": "string", + "title": "Name", + "default": "", + "description": "The name of the service", + "pattern": "^[^\\/]+$", + "examples": ["Local AAA"] + }, + "type": { + "type": "string", + "title": "Type", + "default": "Application", + "description": "If the service is an app or adapter", + "enum": ["Application", "Adapter"] + }, + "properties": { + "type": "object", + "title": "Properties", + "description": "The properties of a service", + "properties": {} + }, + "virtual": { + "type": "boolean", + "title": "virtual", + "default": false, + "description": "Whether or not this service is an Integration.", + "examples": [true, false] + }, + "systemProps": { + "type": "object", + "title": "System Properties", + "description": "Properties used to configure IAP process.", + "properties": { + "maxOldSpaceSize": { + "type": "number", + "title": "maxOldSpaceSize", + "description": "Sets the limit heap memory size on service child process.", + "minimum": 100, + "examples": [2048, 1024] + } + } + }, + "eventDeduplication": { + "type": "object", + "title": "eventDeduplication", + "description": "Properties used by the event-system to deduplicate events", + "required": ["active", "cacheTtl", "uniqueProps"], + "properties": { + "active": { + "type": "boolean", + "description": "Whether or not event deduplication is configured", + "title": "Active" + }, + "cacheTtl": { + "type": "integer", + "description": "The time to live set up for event deduplication", + "title": "Cache Ttl", + "examples": [10000] + }, + "uniqueProps": { + "type": "array", + "description": "Unique properties set up in event deduplication", + "title": "Unique Props", + "items": { + "type": "string", + "examples": ["/messageId"] + } + } + } + } + }, + "oneOf": [ + { + "properties": { + "type": { + "const": "Application" + }, + "properties": { + "properties": {} + } + } + }, + { + "properties": { + "type": { + "const": "Adapter" + }, + "properties": { + "properties": { + "id": { + "type": "string", + "title": "id", + "default": "", + "description": "The id for the service", + "const": { + "$data": "2/name" + }, + "examples": ["Local AAA"] + }, + "type": { + "type": "string", + "title": "Type", + "default": "", + "description": "The type of service", + "examples": ["local_aaa"] + }, + "properties": { + "type": "object", + "properties": {} + }, + "brokers": { + "type": "array", + "uniqueItems": true, + "description": "Brokers which utilize this service", + "items": { + "type": "string", + "description": "Name of the broker", + "enum": [ + "aaa", + "compliance", + "device", + "fault", + "instance", + "inventory", + "method", + "notification", + "performance", + "persistence", + "service", + "topology" + ], + "examples": ["aaa"] + } + }, + "groups": { + "type": "array", + "description": "Groups which can use this service", + "items": { + "type": "string", + "description": "The mongo id of the group", + "examples": ["5fe9f10cc1fca243d562e1d8"], + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["id", "type", "properties", "brokers", "groups"] + } + } + } + ], + "required": [ + "loggerProps", + "isEncrypted", + "model", + "name", + "type", + "properties" + ], + "additionalProperties": false + }, + "iap_services-schema_log_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "iap_services-schema_sys_log_level": { + "type": "string", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "iap_services-schema_name": { + "type": "string", + "title": "Name", + "default": "", + "description": "The name of the service", + "pattern": "^[^\\/]+$", + "examples": ["Local AAA"] + }, + "iap_services-schema_model": { + "type": "string", + "title": "Model", + "default": "", + "description": "The model used by the service", + "examples": ["@itential/adapter-local_aaa"], + "pattern": "^@[-_.a-z]+/.+" + }, + "iap_services-schema_isEncrypted": { + "type": "boolean", + "title": "isEncrypted", + "default": false, + "description": "Whether or not this service is encrypted", + "examples": [true, false] + }, + "iap_services-schema_type": { + "type": "string", + "title": "Type", + "default": "Application", + "description": "If the service is an app or adapter", + "enum": ["Application", "Adapter"] + }, + "iap_services-schema_loggerProps": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description property", + "title": "Description", + "default": "Logger Settings", + "examples": ["Logging"] + }, + "log_directory": { + "type": "string", + "title": "Directory", + "description": "The directory to store Pronghorn log files.", + "default": "/var/log/pronghorn", + "examples": ["/var/log/pronghorn"] + }, + "log_filename": { + "type": "string", + "description": "The name of the current Pronghorn log file.", + "title": "Filename", + "default": "pronghorn.log", + "examples": ["pronghorn.log"] + }, + "log_max_file_size": { + "type": "integer", + "title": "Max File Size", + "description": "The maximum size of each Pronghorn log file in bytes.", + "default": 1048576, + "examples": [1048576] + }, + "log_max_files": { + "type": "integer", + "description": "The maximum number of log files maintained on the server.", + "title": "Max Number of Files", + "default": 100, + "examples": [100] + }, + "log_timezone_offset": { + "type": "integer", + "description": "An integer specifying the offset from GMT/UTC time that will be used when writing to the log files.", + "title": "Timezone Offset", + "default": 0, + "examples": [-5], + "minimum": -12, + "maximum": 12 + }, + "log_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "console_level": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "metrics_filename": { + "type": "string", + "description": "The name of the job metrics log file, if applicable.", + "title": "Metrics Filename", + "default": "metrics.log", + "examples": ["metrics.log"] + }, + "metrics_max_files": { + "type": "integer", + "description": "The maximum number of job metrics log files maintained on the server, if applicable.", + "title": "Max Number of Metrics Files", + "default": 31, + "examples": [31] + }, + "metrics_rotation_interval": { + "type": "string", + "description": "The time until the metrics log is rotated in minutes, hours, days, or weeks, if applicable.", + "title": "Rotation Interval of Metrics Files", + "default": "7d", + "examples": ["7d"] + }, + "metrics_rotation_size": { + "type": "string", + "description": "The maximum file size before the metrics log is rotated in kilobytes, megabytes, or gigabytes, if applicable.", + "title": "Rotation Size of Metrics Files", + "default": "10M", + "examples": ["10M"] + }, + "syslog": { + "type": "object", + "description": "The syslog properties allow Pronghorn to send log messages to a local or remote syslog daemon.", + "properties": { + "level": { + "type": "string", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + }, + "host": { + "type": "string", + "description": "The host running syslogd.", + "title": "Host", + "default": "localhost", + "examples": ["localhost"] + }, + "port": { + "type": "integer", + "description": "The port on the host that syslog is running on.", + "title": "Port", + "default": 514, + "minimum": 1, + "maximum": 65535, + "examples": [514] + }, + "protocol": { + "type": "string", + "title": "Protocol", + "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", + "default": "udp4", + "examples": ["udp4"], + "enum": ["tcp4", "udp4", "unix", "unix-connect"] + }, + "facility": { + "type": "string", + "description": "Syslog facility to use.", + "title": "Facility", + "default": "local0", + "examples": ["local0"] + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", + "default": "BSD", + "examples": ["5424"], + "enum": ["BSD", "5424"] + }, + "path": { + "type": "string", + "title": "Path", + "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X).If path is used, host, port and protocol do not need to be configured.", + "default": "", + "format": "uri-reference", + "examples": ["/dev/log"] + }, + "pid": { + "type": "string", + "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", + "title": "Process Id", + "default": "process.pid", + "examples": ["process.pid"] + }, + "localhost": { + "type": "string", + "description": "Host to indicate that log messages are coming from.", + "title": "Log Host", + "default": "", + "examples": ["localhost"] + }, + "app_name": { + "type": "string", + "description": "The name of the application.", + "title": "Application Name", + "default": "", + "examples": ["process.title"] + }, + "eol": { + "type": "string", + "title": "End of Line Character", + "description": "The end of line character to be added to the end of the message.", + "default": "", + "examples": ["CR"] + } + }, + "allOf": [ + { + "required": ["level", "facility", "type"] + }, + { + "anyOf": [ + { + "required": ["host", "port", "protocol"] + }, + { + "required": ["path"] + } + ] + } + ], + "additionalProperties": false + } + }, + "required": [ + "log_max_files", + "log_max_file_size", + "log_level", + "log_directory", + "log_filename", + "console_level" + ], + "additionalProperties": false + }, + "iap_services-schema_properties": { + "type": "object", + "title": "Properties", + "description": "The properties of a service", + "properties": {} + }, + "iap_services-schema_virtual": { + "type": "boolean", + "title": "virtual", + "default": false, + "description": "Whether or not this service is an Integration.", + "examples": [true, false] + }, + "iap_banner-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "The root schema", + "description": "The root schema comprises the entire JSON document.", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "active": { + "type": "boolean", + "description": "A flag indicating if the banner will be displayed to users" + }, + "text": { + "type": "string", + "description": "Text in the banner when displayed" + }, + "backgroundColor": { + "type": "string", + "description": "The background color for the banner displayed", + "examples": ["#fff"] + }, + "dismissible": { + "type": "boolean", + "description": "A flag indicating if a banner should be dismissible by users" + }, + "startTime": { + "type": "string", + "description": "An ISO Timestring value indicating when the banner will show", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "endTime": { + "type": "string", + "description": "A, ISO Timestring value indicating when the banner will no longer show", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "allPages": { + "type": "boolean", + "description": "A flag indicating if the banner should show on all pages or only the IAP home page" + }, + "image": { + "description": "A base64 image string containing the image that will be shown on the banner", + "type": "string" + }, + "messageLastUpdated": { + "type": "string", + "description": "An ISO Timestring value indicating when the banner message was last updated", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", + "examples": ["2018-08-02T15:56:12.912Z"] + } + }, + "required": ["text", "active", "startTime", "dismissible", "allPages"] + }, + "iap_authorization-common": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Common Authorization Schema" + }, + "iap_authorization-common_accounts-query": { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["john_doe"] + }, + "firstname": { + "type": "string", + "examples": ["John"] + }, + "email": { + "type": "string", + "examples": ["user@email.com"] + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + } + } + }, + "iap_authorization-common_groups-query": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["group1"] + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "description": { + "type": "string", + "examples": ["this is group1"] + } + } + }, + "iap_authorization-common_roles-query": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "examples": ["Custom"] + }, + "name": { + "type": "string", + "examples": ["role_1"] + }, + "description": { + "type": "string", + "examples": ["description of role_1"] + } + } + }, + "iap_authorization-common_roleId": { + "title": "roleId", + "type": "string", + "examples": ["Authorization.admin"] + }, + "iap_groups-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Group Schema", + "description": "This is the schema for an IAP group stored in Mongo", + "properties": { + "provenance": { + "title": "Provenance", + "description": "AAA provider where group originated", + "type": "string", + "examples": ["Local AAA", "Pronghorn"] + }, + "name": { + "title": "Name", + "description": "Name of group", + "type": "string", + "examples": ["group_1"] + }, + "description": { + "title": "Description", + "description": "Description of group", + "type": "string", + "examples": ["description of group_1"] + }, + "memberOf": { + "title": "Assigned Groups", + "description": "Parent groups which this group is a part of", + "type": "array", + "items": { + "type": "object", + "properties": { + "aaaManaged": { + "description": "Whether group comes from an external AAA or not", + "type": "boolean" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "assignedRoles": { + "title": "Assigned Roles", + "description": "Roles assigned to this group", + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + }, + "additionalProperties": false + } + }, + "inactive": { + "title": "Inactive", + "description": "Setting for whether group is active or not", + "type": "boolean" + }, + "_meta": { + "title": "Metadata", + "description": "Metadata for group", + "type": "object", + "properties": { + "created": { + "title": "Created", + "description": "When the group was created", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updated": { + "title": "Updated", + "description": "When the group was last updated", + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + } + } + } + }, + "additionalProperties": false, + "required": [ + "provenance", + "name", + "description", + "memberOf", + "assignedRoles", + "inactive" + ] + }, + "iap_groups-schema_inactive": { + "title": "Inactive", + "description": "Setting for whether group is active or not", + "type": "boolean" + }, + "iap_groups-schema_provenance": { + "title": "Provenance", + "description": "AAA provider where group originated", + "type": "string", + "examples": ["Local AAA", "Pronghorn"] + }, + "iap_groups-schema_name": { + "title": "Name", + "description": "Name of group", + "type": "string", + "examples": ["group_1"] + }, + "iap_groups-schema_description": { + "title": "Description", + "description": "Description of group", + "type": "string", + "examples": ["description of group_1"] + }, + "iap_groups-schema_memberOf": { + "title": "Assigned Groups", + "description": "Parent groups which this group is a part of", + "type": "array", + "items": { + "type": "object", + "properties": { + "aaaManaged": { + "description": "Whether group comes from an external AAA or not", + "type": "boolean" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "iap_groups-schema_assignedRoles": { + "title": "Assigned Roles", + "description": "Roles assigned to this group", + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + }, + "additionalProperties": false + } + }, + "iap_roles-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Role Schema", + "description": "This is the schema for an IAP role stored in Mongo", + "properties": { + "provenance": { + "type": "string", + "examples": ["Custom"] + }, + "name": { + "type": "string", + "examples": ["role_1"] + }, + "description": { + "type": "string", + "examples": ["description of role_1"] + }, + "allowedMethods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["methodName"] + }, + "provenance": { + "type": "string", + "examples": ["ApplicationName"] + } + } + } + }, + "allowedViews": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/manual/task/path"] + }, + "provenance": { + "type": "string", + "examples": ["ApplicationName"] + } + } + } + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updated": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + } + } + } + }, + "additionalProperties": false, + "required": [ + "provenance", + "name", + "description", + "allowedMethods", + "allowedViews" + ] + }, + "iap_roles-schema_name": { + "type": "string", + "examples": ["role_1"] + }, + "iap_roles-schema_description": { + "type": "string", + "examples": ["description of role_1"] + }, + "iap_roles-schema_allowedMethods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["methodName"] + }, + "provenance": { + "type": "string", + "examples": ["ApplicationName"] + } + } + } + }, + "iap_roles-schema_allowedViews": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/manual/task/path"] + }, + "provenance": { + "type": "string", + "examples": ["ApplicationName"] + } + } + } + }, + "iap_system-common": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Common System Schema" + }, + "iap_system-common_methods-query": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["getAdapters"] + }, + "provenance": { + "type": "string", + "examples": ["Adapters"] + }, + "deprecated": { + "type": "boolean" + } + } + }, + "iap_system-common_views-query": { + "type": "object", + "properties": { + "path": { + "type": "string", + "examples": ["/"] + }, + "provenance": { + "type": "string", + "examples": ["WorkFlowEngine"] + } + } + }, + "iap_device-count-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Device Count History Schema", + "description": "This is the schema for an IAP device count stored in Mongo", + "properties": { + "timestamp": { + "type": "string", + "description": "An ISODate representing when the device count was taken", + "examples": ["2023-02-14T20:06:50.569Z"] + }, + "serverId": { + "type": "string", + "description": "The serverId where the device count was taken" + }, + "counts": { + "type": "object", + "description": "The key/value pair between an adapter name and the number of devices", + "additionalProperties": { + "type": "integer", + "minimum": 0 + } + } + }, + "required": ["timestamp", "serverId", "counts"], + "additionalProperties": false + }, + "iap_services-health-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "The root schema", + "description": "The root schema comprises the entire JSON document.", + "properties": { + "id": { + "type": "string", + "examples": ["AdminEssentials"] + }, + "package_id": { + "type": "string", + "title": "Model", + "default": "", + "description": "The model used by the service", + "examples": ["@itential/adapter-local_aaa"], + "pattern": "^@[-_.a-z]+/.+" + }, + "version": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + }, + "type": { + "type": "string", + "enum": ["Adapter", "Application"] + }, + "description": { + "type": "string", + "examples": ["A basic description"] + }, + "state": { + "type": "string", + "enum": ["DEAD", "STOPPED", "RUNNING", "DELETED"] + }, + "connection": { + "type": "object", + "oneOf": [ + { + "const": null + }, + { + "properties": { + "state": { + "type": "string", + "examples": ["ONLINE"] + } + } + } + ] + }, + "uptime": { + "type": "number", + "description": "Number of seconds the current process has been running.", + "examples": [2245.9722] + }, + "memoryUsage": { + "type": "object", + "properties": { + "rss": { + "type": "integer", + "description": "Resident Set Size - the amount of space occupied in the main memory - in bytes", + "examples": [7125982] + }, + "heapTotal": { + "type": "integer", + "description": "Heap Total in bytes for the Node V8 engine", + "examples": [7125982] + }, + "heapUsed": { + "type": "integer", + "description": "Heap Used in bytes by the Node V8 engine", + "examples": [7125982] + }, + "external": { + "type": "integer", + "description": "External usage - memory usage of C++ objects bound to JavaScript objects managed by the Node V8 engine - in bytes", + "examples": [7125982] + } + } + }, + "cpuUsage": { + "type": "object", + "description": "Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)", + "properties": { + "user": { + "description": "Microseconds spent in user mode", + "type": "integer", + "examples": [7125982] + }, + "system": { + "description": "Microseconds spent in system mode", + "type": "integer", + "examples": [7125982] + } + } + }, + "pid": { + "type": "integer", + "examples": [7125982] + }, + "logger": { + "type": "object", + "properties": { + "console": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "file": { + "type": "string", + "examples": ["error", "warn", "info", "debug", "trace", "spam"], + "enum": ["error", "warn", "info", "debug", "trace", "spam"] + }, + "syslog": { + "type": "string", + "examples": ["debug", "info", "warning", "error"], + "enum": ["debug", "info", "warning", "error"] + } + } + }, + "routePrefix": { + "type": "string", + "examples": ["admin", "search"] + }, + "prevUptime": { + "type": "number", + "examples": [2245.9722] + } + } + }, + "iap_services-health-schema_version": { + "type": "string", + "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] + }, + "iap_services-health-schema_cpuUsage": { + "type": "object", + "description": "Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)", + "properties": { + "user": { + "description": "Microseconds spent in user mode", + "type": "integer", + "examples": [7125982] + }, + "system": { + "description": "Microseconds spent in system mode", + "type": "integer", + "examples": [7125982] + } + } + }, + "iap_services-health-schema_uptime": { + "type": "number", + "description": "Number of seconds the current process has been running.", + "examples": [2245.9722] + }, + "iap_services-health-schema_pid": { + "type": "integer", + "examples": [7125982] + }, + "iap_services-health-schema_memoryUsage": { + "type": "object", + "properties": { + "rss": { + "type": "integer", + "description": "Resident Set Size - the amount of space occupied in the main memory - in bytes", + "examples": [7125982] + }, + "heapTotal": { + "type": "integer", + "description": "Heap Total in bytes for the Node V8 engine", + "examples": [7125982] + }, + "heapUsed": { + "type": "integer", + "description": "Heap Used in bytes by the Node V8 engine", + "examples": [7125982] + }, + "external": { + "type": "integer", + "description": "External usage - memory usage of C++ objects bound to JavaScript objects managed by the Node V8 engine - in bytes", + "examples": [7125982] + } + } + }, + "iap_links-query": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential External Link Query Schema", + "description": "This is the schema for queries on IAP external links", + "properties": { + "name": { + "type": "string", + "examples": ["Google"] + }, + "address": { + "type": "string", + "examples": ["https://www.google.com/"] + }, + "description": { + "type": "string", + "examples": ["A link to Google"] + } + }, + "additionalProperties": false + }, + "iap_links-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential External Link Schema", + "description": "This is the schema for an IAP external link stored in Mongo", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "pattern": "^(?![\\s.]+$)[a-zA-Z\\s.]*$", + "examples": ["Google"] + }, + "address": { + "type": "string", + "minLength": 1, + "examples": ["https://www.google.com/"] + }, + "description": { + "type": "string", + "examples": ["A link to Google"] + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updated": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + } + } + } + }, + "required": ["name", "address"], + "additionalProperties": false + }, + "iap_links-schema_name": { + "type": "string", + "minLength": 1, + "pattern": "^(?![\\s.]+$)[a-zA-Z\\s.]*$", + "examples": ["Google"] + }, + "iap_links-schema_address": { + "type": "string", + "minLength": 1, + "examples": ["https://www.google.com/"] + }, + "iap_links-schema_description": { + "type": "string", + "examples": ["A link to Google"] + }, + "iap_repository-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Prebuilt Repository Configuration Schema", + "description": "This is the schema for a Repository Configuration used to fetch Prebuilts", + "properties": { + "enabled": {}, + "type": {}, + "hostname": {}, + "path": {}, + "credentials": {}, + "versionStatus": { + "type": "string", + "description": "The version status of the Pre-built Automation in relation to the current IAP version", + "enum": ["current", "latest"], + "default": "latest" + } + }, + "required": ["enabled", "type", "hostname", "path", "credentials"], + "additionalProperties": false + }, + "iap_repository-schema_enabled": { + "type": "boolean", + "description": "A flag that denotes if the repository configuration is connected", + "enum": [true, false] + }, + "iap_repository-schema_type": { + "type": "string", + "description": "The type of Repository", + "enum": ["gitlab"] + }, + "iap_repository-schema_hostname": { + "type": "string", + "description": "The hostname of the Respository endpoint", + "examples": ["gitlab.com"] + }, + "iap_repository-schema_path": { + "type": "string", + "description": "The path of the Repository endpoint", + "examples": ["itentialopensource/pre-built-automations"] + }, + "iap_repository-schema_credentials": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "An access token used to make HTTP requests", + "examples": ["uTc_P4pnMAEsLbQHmyOt"] + } + }, + "additionalProperties": false + }, + "iap_sso-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "SSO Schema", + "description": "Schema describing an SSO configuration object", + "properties": { + "name": { + "type": "string", + "description": "Name of the SSO configuration", + "examples": ["Auth0", "Okta"] + }, + "ssoType": { + "type": "string", + "description": "Single sign on type, SAML, OpenID, etc.", + "examples": ["saml"], + "enum": ["saml"] + }, + "settings": { + "type": "object", + "description": "The configuration for the sso type used", + "oneOf": [ + { + "type": "object", + "required": [ + "issuer", + "loginURL", + "certificate", + "samlUserNameAttribute", + "samlGroupsAttribute", + "forceLogin" + ], + "additionalProperties": false, + "properties": { + "description": { + "type": "string", + "description": "A description of the sso configuration", + "examples": ["This sso configuration connects to Okta"] + }, + "issuer": { + "type": "string", + "description": "Issuer identity provider", + "examples": ["https://www.auth0.com/oauth2/example"] + }, + "loginURL": { + "type": "string", + "description": "Login URL for SSO identity provider", + "examples": ["https://www.auth0.com/login"] + }, + "logoutURL": { + "type": "string", + "description": "Logout URL for SSO identity provider", + "examples": ["https://www.auth0.com/logout"] + }, + "certificate": { + "type": "string", + "description": "Security certificate", + "examples": [ + "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==" + ] + }, + "samlEmailAttribute": { + "type": "string", + "description": "Attribute containing user email address", + "examples": [ + "mail", + "email", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ], + "default": "email" + }, + "samlUserNameAttribute": { + "type": "string", + "description": "Attribute containing the full user name", + "examples": [ + "userName", + "user", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" + ], + "default": "username" + }, + "samlGroupsAttribute": { + "type": "string", + "description": "Attribute containing the name of the groups property", + "examples": [ + "groups", + "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups" + ], + "default": "groups" + }, + "samlFirstNameAttribute": { + "type": "string", + "description": "Attribute containing the first name of the user", + "examples": [ + "firstName", + "name", + "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" + ] + }, + "forceLogin": { + "type": "boolean", + "description": "A boolean flag indicating if a user is forced to login", + "title": "Force User Login", + "default": false + } + } + } + ] + }, + "active": { + "description": "Whether or not the SSO Config is selected for use. For 'active' to be true, 'tested' must also be true.", + "type": "boolean", + "default": false + }, + "tested": { + "type": "boolean", + "description": "Whether the sso config was tested" + } + }, + "required": ["name", "ssoType", "settings"], + "additionalProperties": false + }, + "iap_sso-schema_samlConfig": { + "type": "object", + "required": [ + "issuer", + "loginURL", + "certificate", + "samlUserNameAttribute", + "samlGroupsAttribute", + "forceLogin" + ], + "additionalProperties": false, + "properties": { + "description": { + "type": "string", + "description": "A description of the sso configuration", + "examples": ["This sso configuration connects to Okta"] + }, + "issuer": { + "type": "string", + "description": "Issuer identity provider", + "examples": ["https://www.auth0.com/oauth2/example"] + }, + "loginURL": { + "type": "string", + "description": "Login URL for SSO identity provider", + "examples": ["https://www.auth0.com/login"] + }, + "logoutURL": { + "type": "string", + "description": "Logout URL for SSO identity provider", + "examples": ["https://www.auth0.com/logout"] + }, + "certificate": { + "type": "string", + "description": "Security certificate", + "examples": [ + "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==" + ] + }, + "samlEmailAttribute": { + "type": "string", + "description": "Attribute containing user email address", + "examples": [ + "mail", + "email", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ], + "default": "email" + }, + "samlUserNameAttribute": { + "type": "string", + "description": "Attribute containing the full user name", + "examples": [ + "userName", + "user", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" + ], + "default": "username" + }, + "samlGroupsAttribute": { + "type": "string", + "description": "Attribute containing the name of the groups property", + "examples": [ + "groups", + "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups" + ], + "default": "groups" + }, + "samlFirstNameAttribute": { + "type": "string", + "description": "Attribute containing the first name of the user", + "examples": [ + "firstName", + "name", + "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" + ] + }, + "forceLogin": { + "type": "boolean", + "description": "A boolean flag indicating if a user is forced to login", + "title": "Force User Login", + "default": false + } + } + }, + "iap_mapping-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential Group Mapping Schema", + "description": "This is the schema for an IAP group mapping stored in Mongo", + "properties": { + "externalGroup": { + "type": "string", + "description": "name of the external group" + }, + "provenance": { + "type": "string", + "description": "The AAA provider for the external group", + "examples": ["Okta"] + }, + "iapGroups": { + "type": "array", + "items": { + "type": "string", + "description": "ObjectId for the group within IAP" + } + } + }, + "required": ["externalGroup", "iapGroups", "provenance"], + "additionalProperties": false + }, + "iap_mapping-schema_iapGroups": { + "type": "array", + "items": { + "type": "string", + "description": "ObjectId for the group within IAP" + } + }, + "iap_mapping-schema_externalGroup": { + "type": "string", + "description": "name of the external group" + }, + "iap_mapping-schema_provenance": { + "type": "string", + "description": "The AAA provider for the external group", + "examples": ["Okta"] + }, + "iap_git-common": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Common Git Schema" + }, + "iap_git-common_type": { + "type": "string", + "description": "The type of Git provider being used", + "enum": ["GitHub", "GitLab"] + }, + "iap_git-common_repoPath": { + "title": "repoPath", + "description": "The path in Git to the repository", + "type": "string", + "examples": ["github-organization", "gitlabGroup%2FsubGroup"] + }, + "iap_git-common_branchName": { + "title": "branchName", + "description": "The name of the branch inside a Git repository", + "type": "string", + "examples": ["main"] + }, + "iap_git-common_projectPath": { + "title": "repoPath", + "description": "The file path within a Git repository to a project file", + "type": "string", + "examples": ["directory%2Fproject.json", "example.json"] + }, + "iap_git-common_commitMessage": { + "title": "commitMessage", + "description": "The commit message sent to Git when updating a project", + "type": "string", + "examples": ["This is an example commit message."] + }, + "iap_service-accounts-schema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "title": "Itential OAuth Service Account Schema", + "description": "This is the schema for an OAuth service account stored in Mongo", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "name": { + "type": "string", + "description": "The name associated with the service account", + "examples": ["ExampleName"] + }, + "description": { + "type": "string", + "description": "The description of the service account", + "examples": [ + "This is a service account for the external Example system" + ] + }, + "clientId": {}, + "clientSecret": { + "type": "string", + "description": "Uuid representation of client secret", + "examples": ["d4c673d6-17f8-4e76-8034-a87820f96618"] + }, + "_meta": { + "type": "object", + "properties": { + "updated": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "updatedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "created": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + } + } + } + }, + "additionalProperties": false, + "required": ["name", "description", "clientId", "clientSecret"] + }, + "iap_service-accounts-schema_name": { + "type": "string", + "description": "The name associated with the service account", + "examples": ["ExampleName"] + }, + "iap_service-accounts-schema_description": { + "type": "string", + "description": "The description of the service account", + "examples": [ + "This is a service account for the external Example system" + ] + }, + "iap_service-accounts-schema_clientId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "iap_service-accounts-schema_clientSecret": { + "type": "string", + "description": "Uuid representation of client secret", + "examples": ["d4c673d6-17f8-4e76-8034-a87820f96618"] + }, + "iap_service-accounts-schema_modifiedByDereferenced": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "String representation of a MongoDB ObjectId", + "examples": ["5cb7b531d06cceb89fd21b1c"] + }, + "username": { + "type": "string", + "examples": ["username@itential"] + } + } + }, + "iap_service-accounts-schema_timestamp": { + "type": "string", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "formbuilder_formDocument": { + "title": "form document", + "description": "A form document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + "name": { + "type": "string", + "examples": ["Form 123"] + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time" + }, + "created_by": {}, + "last_updated": { + "type": "string", + "format": "date-time" + }, + "last_updated_by": {}, + "elements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["service_model"] + }, + "id": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["/ncs:services/test_devices:service_name"] + } + }, + "required": ["name"] + } + }, + "required": ["type", "id"] + }, + "examples": [ + [ + { + "type": "method", + "id": { + "name": "method_name_1" + } + } + ] + ] + }, + "children": { + "type": "array", + "items": { + "type": "object", + "required": ["properties", "id", "type"], + "properties": { + "id": { + "type": "string", + "oneOf": [ + { + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + { + "pattern": "cont-." + } + ] + }, + "element": { + "type": "string", + "examples": [ + "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}" + ] + }, + "type": { + "type": "string", + "examples": ["container"] + }, + "name": { + "type": "string", + "examples": ["vlan_id_123"] + }, + "display_name": { + "type": "string", + "examples": ["vlan"] + }, + "source_type": { + "type": "string", + "enum": ["service_model", "custom", "method"] + }, + "source": { + "type": "string", + "examples": ["/ncs:services/abc_devices:ios.device"] + }, + "key": { + "type": "string", + "examples": [ + "service.vlanid", + "key_545385c3-fc66-491b-bf6f-abc2214366dc" + ] + }, + "properties": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["leafref"] + }, + "path": { + "type": "string", + "examples": ["/ncs:devices/ncs:device/ncs:name"] + }, + "min": { + "anyOf": [ + { + "type": "string", + "examples": ["1"] + }, + { + "type": "integer", + "examples": [1] + }, + { + "type": "null" + } + ] + }, + "max": { + "anyOf": [ + { + "type": "string", + "examples": ["4"] + }, + { + "type": "integer", + "examples": [1] + }, + { + "type": "null" + } + ] + }, + "minLength": { + "anyOf": [ + { + "type": "string", + "examples": ["1"] + }, + { + "type": "integer", + "examples": [1] + }, + { + "type": "null" + } + ] + }, + "maxLength": { + "anyOf": [ + { + "type": "string", + "examples": ["4"] + }, + { + "type": "integer", + "examples": [1] + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "direction": { + "type": "string", + "examples": ["vertical"] + }, + "required": { + "type": "boolean" + }, + "enforce": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + } + } + } + }, + "examples": [ + { + "type": "field", + "name": "ipaddress", + "properties": { + "type": "string", + "prefix": "" + }, + "description": "IP address", + "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}", + "source_type": "method", + "source": "method_name_1", + "id": "a40044c2-f378-4b2b-a81a-41d78979e583", + "yangkey": "", + "key": "method_name_1.ipAddress" + } + ] + } + } + }, + "required": ["name", "children", "elements"] + }, + "formbuilder_formDocument_formName": { + "type": "string", + "examples": ["Form 123"] + }, + "formbuilder_formDocument_ObjectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formbuilder_formDocument_uuidv4": { + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + "formbuilder_formDocument_groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "formbuilder_formDocument_elements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["service_model"] + }, + "id": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["/ncs:services/test_devices:service_name"] + } + }, + "required": ["name"] + } + }, + "required": ["type", "id"] + }, + "examples": [ + [ + { + "type": "method", + "id": { + "name": "method_name_1" + } + } + ] + ] + }, + "search_searchResults": { + "title": "search results", + "description": "The results of a search", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "examples": [ + "Forms", + "The Title of the Application the result came from." + ] + }, + "type": { + "type": "string", + "examples": [ + "forms", + "The name of the Collection the result came from" + ] + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": [ + "912fd926-5391-48ff-b265-394d00640f4f", + "The id of the result." + ] + }, + "name": { + "type": "string", + "examples": ["testForm", "Name of the result."] + }, + "description": { + "type": "string", + "examples": [ + "Hi I describe the result", + "Description for the result is optional." + ] + }, + "url": { + "type": "string", + "examples": [ + "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f", + "The shortened url to access the result from." + ] + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": [ + "5c8fa4a8d8e04500b1b2f28f", + "The id of the tag." + ] + }, + "description": { + "type": "string", + "examples": [ + "Hi I describe the tag", + "Description for the tag is optional." + ] + }, + "name": { + "type": "string", + "examples": ["testTag", "Name of the tag."] + } + } + } + } + } + } + }, + "count": { + "type": "integer" + } + } + } + } + } + }, + "configuration_manager_common_mongoObjectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "configuration_manager_common_timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "configuration_manager_common_standardName": { + "type": "string", + "examples": ["my standard name"], + "minLength": 1 + }, + "configuration_manager_common_standardDescription": { + "type": "string", + "examples": ["my standard description"], + "minLength": 1 + }, + "configuration_manager_common_multiElementString": { + "type": "string", + "examples": ["device1, device2, device3, device4"], + "minLength": 1 + }, + "configuration_manager_deviceData_deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "configuration_manager_deviceData_deviceDetails": { + "title": "deviceDetails", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["xr9kv01-aws"] + }, + "authgroup": { + "type": "string", + "examples": ["xr9kv-aws"] + }, + "ipaddress": { + "type": "string", + "examples": ["10.1.6.100"] + }, + "address": { + "type": "string", + "examples": ["10.1.6.100"] + }, + "port": { + "type": "string", + "examples": ["22"] + }, + "device-type": { + "type": "string", + "examples": ["cli"] + }, + "ostype": { + "type": "string", + "examples": ["cisco-ios-xr"] + }, + "ned": { + "type": "string", + "examples": ["cisco-ios-xr"] + }, + "admin": { + "type": "boolean" + }, + "host": { + "type": "string", + "examples": ["nso46"] + }, + "actions": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "addDevice", + "addDeviceGroup", + "addDeviceToGroup", + "addToAuthGroup", + "applyTemplate", + "applyTemplates", + "applyVariableTemplate", + "checkSync", + "checkSyncDevices", + "isAlive", + "deleteDevice", + "deleteDeviceGroup", + "dryRunVariableTemplate", + "getAuthGroups", + "getConfig", + "getDevice", + "getDeviceGroups", + "getDeviceGroupsForDevices", + "getDevices", + "getDevicesFiltered", + "getNEDs", + "getOutOfSyncConfig", + "getTemplates", + "liveStatus", + "passThru", + "pingDevice", + "removeDeviceFromGroup", + "restoreDevice", + "runAction", + "runCommand", + "setConfig", + "syncFrom", + "syncFromDevices", + "syncTo", + "syncToDevices", + "turnUpDevice", + "verifyConfig" + ] + }, + "uniqueItems": true + }, + "origins": { + "type": "array", + "items": { + "type": "string", + "examples": ["nso46"] + } + } + }, + "required": [ + "name", + "device-type", + "ipaddress", + "port", + "ostype", + "host", + "actions", + "origin" + ] + }, + "configuration_manager_deviceData_deviceConfigurationFormat": { + "title": "format", + "type": "string", + "enum": ["native", "xml", "json"], + "examples": ["native"] + }, + "configuration_manager_deviceData_deviceConfiguration": { + "title": "config", + "type": "object", + "properties": { + "device": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "config": { + "type": "string", + "examples": ["hostname ios0\nno service password-encryption\n..."] + } + } + }, + "configuration_manager_deviceData_deviceConfigurationString": { + "type": "string", + "examples": ["hostname ios0\nno service password-encryption\n..."] + }, + "configuration_manager_deviceData_backupDescription": { + "type": "string", + "examples": ["description of backup"] + }, + "configuration_manager_deviceData_backupNotes": { + "type": "string", + "examples": ["notes about backup"] + }, + "configuration_manager_deviceData_backup": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "provider": { + "type": "string" + }, + "type": { + "title": "format", + "type": "string", + "enum": ["native", "xml", "json"], + "examples": ["native"] + }, + "date": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "rawConfig": { + "type": "string", + "examples": ["hostname ios0\nno service password-encryption\n..."] + }, + "description": { + "type": "string", + "examples": ["description of backup"] + }, + "notes": { + "type": "string", + "examples": ["notes about backup"] + }, + "gbac": { + "type": "object", + "description": "Sets of group Ids that are allowd to access this automation.", + "properties": { + "write": { + "type": "array", + "description": "Group ids that have write access to the automation document.", + "items": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + }, + "read": { + "type": "array", + "description": "Group ids that have read access to the automation document.", + "items": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + }, + "required": ["write", "read"] + } + } + }, + "configuration_manager_deviceGroupDocument": { + "$schema": "http://json-schema.org/draft-07/schema#", + "description": "A group of devices that are referenced by name only", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string", + "examples": ["my standard name"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["my standard description"], + "minLength": 1 + }, + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + } + }, + "additionalProperties": true + }, + "configuration_manager_deviceGroupDocument_groupDetails": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["my standard name"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["my standard description"], + "minLength": 1 + }, + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + } + }, + "required": ["name"], + "additionalProperties": false + }, + "configuration_manager_deviceGroupDocument_updateGroupDetails": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["my standard name"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["my standard description"], + "minLength": 1 + }, + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + } + }, + "additionalProperties": false + }, + "configuration_manager_deviceGroupDocument_createGroupResponseWithName": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string" + }, + "message": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "required": ["id", "name", "message", "status"] + }, + "configuration_manager_deviceGroupDocument_updateGroupsResponse": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "modified": { + "type": "number" + } + }, + "required": ["status", "modified"] + }, + "configuration_manager_deviceGroupDocument_deleteGroupResponse": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "deleted": { + "type": "number" + } + }, + "required": ["status", "deleted"] + }, + "configuration_manager_goldenConfigData_goldenConfigNodePath": { + "title": "goldenConfigNodePath", + "type": "string", + "examples": ["base", "base/US East", "base/US East/Atlanta"] + }, + "configuration_manager_goldenConfigData_goldenConfigTreeVersionName": { + "title": "goldenConfigTreeVersionName", + "type": "string", + "examples": ["initial", "v2", "v3", "draft-v4"] + }, + "configuration_manager_goldenConfigData_goldenConfigNode": { + "title": "goldenConfigNode", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["base", "us-east", "edge"] + }, + "attributes": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "children": { + "type": "array", + "items": { + "title": "goldenConfigNode", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["base", "us-east", "edge"] + }, + "attributes": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "children": { + "type": "array", + "items": {} + } + }, + "required": ["name", "attributes", "children"] + } + } + }, + "required": ["name", "attributes", "children"] + }, + "configuration_manager_goldenConfigData_goldenConfigTreeVersion": { + "title": "goldenConfigTreeVersion", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string", + "examples": [ + "Cisco Edge - Day 0", + "Cisco Edge - Day 1", + "Cisco Core - Day 0", + "Cisco Core - Day 1" + ] + }, + "deviceType": { + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "version": { + "type": "string", + "examples": ["initial", "v2", "v3", "draft v4"] + }, + "root": { + "title": "goldenConfigNode", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["base", "us-east", "edge"] + }, + "attributes": { + "type": "object", + "properties": { + "devices": { + "type": "array", + "items": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + } + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "children": { + "type": "array", + "items": {} + } + }, + "required": ["name", "attributes", "children"] + }, + "variables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["variable name"] + }, + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["variable value"] + } + } + } + }, + "created": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "lastUpdated": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "lastUpdatedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary": { + "title": "goldenConfigTreeVersion", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "name": { + "type": "string", + "examples": [ + "Cisco Edge - Day 0", + "Cisco Edge - Day 1", + "Cisco Core - Day 0", + "Cisco Core - Day 1" + ] + }, + "deviceType": { + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "versions": { + "type": "array", + "items": { + "type": "string", + "examples": ["initial", "v2", "v3", "draft v4"] + } + }, + "created": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "lastUpdated": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigSpecWord": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigSpecLineId": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "configuration_manager_goldenConfigData_goldenConfigSpecLine": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": ["required", "disallowed", "ignored", "optional"] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": ["required", "disallowed", "ignored", "optional"] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigSpec": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "deviceType": { + "type": "string", + "examples": [ + "cisco-ios", + "cisco-ios-xr", + "cisco-nx", + "a10-acos", + "f5-big-ip" + ] + }, + "lines": { + "type": "array", + "items": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": ["required", "disallowed", "ignored", "optional"] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": {} + } + } + } + }, + "created": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "lastUpdated": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "lastUpdatedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigJSONSpec": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "deviceType": { + "type": "string", + "examples": ["json"] + }, + "data": { + "type": "object", + "properties": {} + }, + "created": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "lastUpdated": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "lastUpdatedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + } + }, + "configuration_manager_goldenConfigData_goldenConfigVariables": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["variable name"] + }, + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["variable value"] + } + } + } + }, + { + "type": "object", + "properties": {}, + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["string value", "^regular.*expression$"] + } + } + }, + { + "type": "string", + "examples": ["string value"] + } + ] + } + } + ] + }, + "configuration_manager_goldenConfigData_reportGradingOptions": { + "type": "object", + "properties": { + "weights": { + "type": "object", + "properties": { + "error": { + "type": "number" + }, + "warning": { + "type": "number" + }, + "info": { + "type": "number" + } + } + }, + "benchmarks": { + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "number" + } + } + } + }, + "configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions": { + "type": "object", + "properties": { + "weights": { + "type": "object", + "properties": { + "error": { + "type": "number" + }, + "warning": { + "type": "number" + }, + "info": { + "type": "number" + } + } + }, + "benchmarks": { + "type": "object", + "properties": {}, + "additionalProperties": { + "type": "number" + } + }, + "limit": { + "type": "integer", + "minimum": 1 + } + } + }, + "configuration_manager_goldenConfigData_complianceSummary": { + "title": "complianceSummary", + "type": "object", + "properties": { + "errors": { + "type": "integer", + "minimum": 0 + }, + "warnings": { + "type": "integer", + "minimum": 0 + }, + "passes": { + "type": "integer", + "minimum": 0 + }, + "infos": { + "type": "integer", + "minimum": 0 + }, + "deviceWithErrors": { + "type": "integer", + "minimum": 0 + }, + "deviceWithWarnings": { + "type": "integer", + "minimum": 0 + }, + "deviceWithInfos": { + "type": "integer", + "minimum": 0 + }, + "fullyCompliantDevices": { + "type": "integer", + "minimum": 0 + }, + "numDevices": { + "type": "integer", + "minimum": 0 + } + } + }, + "configuration_manager_goldenConfigData_complianceReport": { + "title": "complianceReport", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "batchId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "treeId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "version": { + "title": "goldenConfigTreeVersionName", + "type": "string", + "examples": ["initial", "v2", "v3", "draft-v4"] + }, + "nodePath": { + "title": "goldenConfigNodePath", + "type": "string", + "examples": ["base", "base/US East", "base/US East/Atlanta"] + }, + "deviceType": { + "type": "string", + "examples": ["cisco-ios", "cisco-ios-xr", "junos"] + }, + "specId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "inheritedSpecIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + }, + "deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "variables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["variable name"] + }, + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["variable value"] + } + } + } + }, + "timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "totals": { + "type": "object", + "properties": { + "errors": { + "type": "integer", + "minimum": 0 + }, + "warnings": { + "type": "integer", + "minimum": 0 + }, + "infos": { + "type": "integer", + "minimum": 0 + }, + "passes": { + "type": "integer", + "minimum": 0 + } + } + }, + "issues": { + "type": "array", + "items": { + "title": "complianceIssue", + "type": "object", + "properties": { + "severity": { + "enum": ["error", "warning", "info"] + }, + "type": { + "enum": ["required", "disallowed"] + }, + "message": { + "type": "string", + "examples": ["Required config not found"] + }, + "specLineId": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "path": { + "type": "array", + "items": { + "type": "string", + "examples": ["interface GigE1"] + } + }, + "spec": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": ["required", "disallowed", "ignored", "optional"] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": {} + } + } + }, + "configWords": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "literal" + }, + "value": { + "type": "string", + "examples": ["word"] + } + } + } + }, + "candidates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "literal" + }, + "value": { + "type": "string", + "examples": ["word"] + } + } + } + } + } + } + }, + "score": { + "type": "number" + } + } + }, + "configuration_manager_goldenConfigData_complianceReportBrief": { + "title": "complianceReportBrief", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "batchId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "treeId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "version": { + "type": "string", + "examples": ["initial", "v2", "v3", "draft v4"] + }, + "nodePath": { + "title": "goldenConfigNodePath", + "type": "string", + "examples": ["base", "base/US East", "base/US East/Atlanta"] + }, + "deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "totals": { + "type": "object", + "properties": { + "errors": { + "type": "integer", + "minimum": 0 + }, + "warnings": { + "type": "integer", + "minimum": 0 + }, + "infos": { + "type": "integer", + "minimum": 0 + }, + "passes": { + "type": "integer", + "minimum": 0 + } + } + } + } + }, + "configuration_manager_goldenConfigData_complianceReportBriefGraded": { + "title": "complianceReportBriefGraded", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "nodePath": { + "type": "string", + "examples": ["base/US East/Atlanta"] + }, + "deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "error": { + "type": "integer", + "minimum": 0 + }, + "warning": { + "type": "integer", + "minimum": 0 + }, + "info": { + "type": "integer", + "minimum": 0 + }, + "pass": { + "type": "integer", + "minimum": 0 + }, + "score": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "grade": { + "type": "string", + "examples": ["pass", "review", "fail"] + } + } + }, + "configuration_manager_goldenConfigData_complianceReportGraded": { + "title": "complianceReportGraded", + "allOf": [ + { + "title": "complianceReport", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "batchId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "treeId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "version": { + "title": "goldenConfigTreeVersionName", + "type": "string", + "examples": ["initial", "v2", "v3", "draft-v4"] + }, + "nodePath": { + "title": "goldenConfigNodePath", + "type": "string", + "examples": ["base", "base/US East", "base/US East/Atlanta"] + }, + "deviceType": { + "type": "string", + "examples": ["cisco-ios", "cisco-ios-xr", "junos"] + }, + "specId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + }, + "inheritedSpecIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "examples": ["5c35355dbebaa82eaf8113f0"] + } + }, + "deviceName": { + "type": "string", + "title": "name", + "examples": ["xr9kv-atl"] + }, + "variables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["variable name"] + }, + "type": { + "type": "string", + "enum": ["literal", "regex"] + }, + "value": { + "type": "string", + "examples": ["variable value"] + } + } + } + }, + "timestamp": { + "type": "string", + "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", + "examples": ["2019-04-12T14:42:47.958Z"] + }, + "totals": { + "type": "object", + "properties": { + "errors": { + "type": "integer", + "minimum": 0 + }, + "warnings": { + "type": "integer", + "minimum": 0 + }, + "infos": { + "type": "integer", + "minimum": 0 + }, + "passes": { + "type": "integer", + "minimum": 0 + } + } + }, + "issues": { + "type": "array", + "items": { + "title": "complianceIssue", + "type": "object", + "properties": { + "severity": { + "enum": ["error", "warning", "info"] + }, + "type": { + "enum": ["required", "disallowed"] + }, + "message": { + "type": "string", + "examples": ["Required config not found"] + }, + "specLineId": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "path": { + "type": "array", + "items": { + "type": "string", + "examples": ["interface GigE1"] + } + }, + "spec": { + "title": "goldenConfigSpecLine", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{16}$", + "examples": [ + "5c353f69d085d85c", + "5c353f69e69c9dc4", + "5c353f691dd5c3b9", + "5c9964aa0d66293a", + "5c353f694ed8385d", + "5c353f699915cc4a", + "5c353f692edfafcf", + "5c353f6940fd1ec5", + "5c353f6932963635" + ] + }, + "evalMode": { + "type": "string", + "enum": [ + "required", + "disallowed", + "ignored", + "optional" + ] + }, + "severity": { + "type": "string", + "enum": ["error", "warning", "info"] + }, + "words": { + "type": "array", + "items": { + "title": "goldenConfigSpecWord", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["literal", "regex", "variable"] + }, + "value": { + "type": "string", + "examples": [ + " or or " + ] + } + } + } + }, + "lines": { + "type": "array", + "items": {} + } + } + }, + "configWords": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "literal" + }, + "value": { + "type": "string", + "examples": ["word"] + } + } + } + }, + "candidates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "literal" + }, + "value": { + "type": "string", + "examples": ["word"] + } + } + } + } + } + } + }, + "score": { + "type": "number" + } + } + }, + { + "type": "object", + "properties": { + "score": { + "type": "number" + }, + "grade": { + "type": "string", + "examples": ["pass", "fail", "review"] + } + } + } + ] + }, + "automation-studio_automation": { + "title": "workflow document", + "description": "Third generation workflow document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "namespace": { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + }, + "name": { + "type": "string", + "examples": [ + "Port Turn Up IOS", + "Push Config to Device", + "Command Template Runner" + ] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "string", + "examples": ["Port Turn Up IOS", "Push Config to Device"] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "integer", + "title": "Pre automation time of automation", + "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", + "examples": [5000, 250000] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "workflow_end": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "sla": { + "type": "integer", + "title": "Task SLA", + "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", + "examples": ["3600000"] + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": {}, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": {}, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "canvasVersion": { + "type": "number", + "const": 3 + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + } + }, + "additionalProperties": false, + "required": [ + "name", + "type", + "tasks", + "transitions", + "groups", + "canvasVersion" + ] + }, + "automation-studio_automationUpdate": { + "title": "workflow document", + "description": "Third generation workflow document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "namespace": { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + }, + "name": { + "type": "string", + "examples": [ + "Port Turn Up IOS", + "Push Config to Device", + "Command Template Runner" + ] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "string", + "examples": ["Port Turn Up IOS", "Push Config to Device"] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "integer", + "title": "Pre automation time of automation", + "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", + "examples": [5000, 250000] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "workflow_end": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "sla": { + "type": "integer", + "title": "Task SLA", + "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", + "examples": ["3600000"] + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": {}, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": {}, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "canvasVersion": { + "type": "number", + "const": 3 + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + } + }, + "additionalProperties": false, + "required": [ + "name", + "type", + "tasks", + "transitions", + "groups", + "canvasVersion" + ] + }, + "automation-studio_componentGroup": { + "title": "Component Group Document", + "description": "An entity representing a component group.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the component group" + }, + "name": { + "type": "string", + "examples": ["Infoblox Workflows"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["Infoblox Workflows"] + }, + "gbacRead": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "CAcFAfEa9aCe7ba08d482B3F", + "F880C8dEBAf70BfB85ec7eCc", + "5AC59E1De2Ce2203cFeb3E22" + ] + } + }, + "gbacWrite": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "CAcFAfEa9aCe7ba08d482B3F", + "F880C8dEBAf70BfB85ec7eCc", + "5AC59E1De2Ce2203cFeb3E22" + ] + } + }, + "members": { + "type": "array", + "items": { + "type": "object", + "oneOf": [ + { + "properties": { + "path": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + } + }, + "type": { + "enum": ["folder"] + } + } + }, + { + "properties": { + "path": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + }, + "type": { + "enum": ["component"] + }, + "sourceCollection": { + "type": "string", + "examples": ["workflows", "json-forms", "transformations"] + }, + "ref": { + "type": "string", + "examples": ["7192B8CcD680858dA81EADCa"] + } + } + } + ] + } + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "meta": { + "type": "object" + } + }, + "required": ["name", "gbacRead", "members"], + "additionalProperties": false + }, + "automation-studio_componentGroupImport": { + "title": "Component Group Import Data", + "description": "Data to import as a new component group document.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the component group" + }, + "name": { + "type": "string", + "examples": ["Assign Next IP - Infoblox", "Get Next IP - Infoblox"], + "minLength": 1 + }, + "gbacRead": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "CAcFAfEa9aCe7ba08d482B3F", + "F880C8dEBAf70BfB85ec7eCc", + "5AC59E1De2Ce2203cFeb3E22" + ] + } + }, + "members": { + "type": "array", + "items": { + "type": "object", + "oneOf": [ + { + "properties": { + "path": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + } + }, + "type": { + "enum": ["folder"] + } + } + }, + { + "properties": { + "path": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + }, + "type": { + "enum": ["component"] + }, + "sourceCollection": { + "type": "string", + "examples": ["workflows", "json-forms", "transformations"] + }, + "ref": { + "type": "string", + "examples": ["7192B8CcD680858dA81EADCa"] + } + } + } + ] + } + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "meta": { + "type": "object" + } + }, + "required": ["name", "gbacRead", "members"], + "additionalProperties": false + }, + "automation-studio_componentGroupUpdate": { + "title": "Component Group Update", + "description": "An entity representing an update to an existing template document.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the component group" + }, + "name": { + "type": "string", + "examples": ["Assign Next IP - Infoblox", "Get Next IP - Infoblox"], + "minLength": 1 + }, + "gbacRead": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "CAcFAfEa9aCe7ba08d482B3F", + "F880C8dEBAf70BfB85ec7eCc", + "5AC59E1De2Ce2203cFeb3E22" + ] + } + }, + "members": { + "type": "array", + "items": { + "type": "object", + "oneOf": [ + { + "properties": { + "path": { + "type": "array", + "items": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + } + }, + "type": { + "enum": ["folder"] + } + } + }, + { + "properties": { + "path": { + "type": "string", + "examples": [ + "Assign Next IP - Infoblox", + "Get Next IP - Infoblox" + ] + }, + "type": { + "enum": ["component"] + }, + "sourceCollection": { + "type": "string", + "examples": ["workflows", "json-forms", "transformations"] + }, + "ref": { + "type": "string", + "examples": ["7192B8CcD680858dA81EADCa"] + } + } + } + ] + } + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "meta": { + "type": "object" + } + }, + "required": ["name", "gbacRead", "members"], + "additionalProperties": false + }, + "automation-studio_project-thumbnails-update-data": { + "title": "Project Thumbnail Update Values", + "description": "Project Thumbnail Update Values", + "type": "object", + "required": ["imageData"], + "properties": { + "imageData": { + "description": "Binary image data encoded as a base64 string", + "type": "string" + }, + "backgroundColor": { + "description": "Thumbnail background color", + "type": "string", + "default": "#FFFFFF" + } + } + }, + "automation-studio_projects-common_components": { + "title": "Project components", + "description": "A list of member components in the project", + "type": "array", + "items": { + "title": "Project component", + "description": "An IAP component which resides within a project", + "type": "object", + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string", + "examples": [ + "1Ac4B2268489019745B5baa4", + "2D772A00dd2Ccedf3bd313bd", + "866a9B98DdD58Ff0e14ebB16" + ] + }, + "folder": { + "title": "Project component folder", + "description": "", + "type": "string", + "pattern": "^/" + } + } + } + }, + "automation-studio_projects-create-data": { + "title": "Project Create Data", + "description": "POST body properties required to create a project", + "type": "object", + "additionalProperties": true, + "required": ["name"], + "properties": { + "name": { + "description": "Project name", + "type": "string", + "examples": [ + "Firewall Service Provisioning", + "Arista EOS Utilities", + "Github" + ] + }, + "description": { + "title": "Project description", + "description": "A free-form block of text for describing project intent and function", + "type": "string", + "examples": [ + "This project is used at Acme Corp as the foundation of some major parts of our business process.", + "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" + ] + }, + "components": { + "title": "Project components", + "description": "A list of member components in the project", + "type": "array", + "items": { + "title": "Project component", + "description": "An IAP component which resides within a project", + "type": "object", + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string", + "examples": [ + "1Ac4B2268489019745B5baa4", + "2D772A00dd2Ccedf3bd313bd", + "866a9B98DdD58Ff0e14ebB16" + ] + }, + "folder": { + "title": "Project component folder", + "description": "", + "type": "string", + "pattern": "^/" + } + } + } + } + } + }, + "automation-studio_projects-export-v1": { + "title": "Project Export Document", + "description": "An exported project document", + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "iid", + "name", + "description", + "thumbnail", + "backgroundColor", + "components", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "name": { + "description": "Project name", + "type": "string", + "examples": [ + "Firewall Service Provisioning", + "Arista EOS Utilities", + "Github" + ] + }, + "description": { + "title": "Project description", + "description": "A free-form block of text for describing project intent and function", + "type": "string", + "examples": [ + "This project is used at Acme Corp as the foundation of some major parts of our business process.", + "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" + ] + }, + "thumbnail": { + "description": "Base64 string encoding binary image data for project thumbnail", + "type": "string" + }, + "backgroundColor": { + "description": "Thumbnail background color", + "type": "string", + "default": "#FFFFFF" + }, + "components": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": ["iid", "type", "reference", "folder", "document"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string", + "examples": [ + "1Ac4B2268489019745B5baa4", + "2D772A00dd2Ccedf3bd313bd", + "866a9B98DdD58Ff0e14ebB16" + ] + }, + "folder": { + "title": "Project component folder", + "description": "", + "type": "string", + "pattern": "^/" + }, + "document": { + "title": "Component export", + "description": "Full component document", + "type": "object" + } + } + } + }, + "referencedComponentHashes": { + "oneOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "items": { + "type": "object", + "additionalProperties": false, + "required": ["type", "reference", "hash", "name"], + "properties": { + "type": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The last known name of the exported document" + }, + "hash": { + "type": "string" + }, + "query": { + "type": "object" + } + } + } + }, + "referencedComponents": { + "oneOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "items": { + "type": "object", + "additionalProperties": false, + "required": ["type", "reference", "document"], + "properties": { + "type": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "document": { + "title": "Referenced component export", + "description": "Full referenced component document", + "type": "object" + } + } + } + }, + "folders": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "required": ["name", "nodeType", "children"], + "properties": { + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "name": { + "description": "Folder name", + "type": "string", + "examples": ["folder-1", "folder-2"] + }, + "children": { + "type": "array", + "items": { + "oneOf": [ + {}, + { + "type": "object", + "required": ["iid", "nodeType"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string" + } + } + } + ] + } + } + } + }, + { + "type": "object", + "required": ["iid", "nodeType"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string" + } + } + } + ] + } + }, + "created": { + "title": "ISO Date String", + "description": "ISO Date String", + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "createdBy": {}, + "lastUpdated": { + "title": "ISO Date String", + "description": "ISO Date String", + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "lastUpdatedBy": {}, + "versionHistory": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": [ + "versionNumber", + "commitMessage", + "author", + "branchName" + ], + "properties": { + "versionNumber": { + "type": "integer", + "examples": [1] + }, + "commitMessage": { + "type": "string" + }, + "author": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + } + } + } + } + } + }, + "automation-studio_projects-http-id": { + "title": "Projects HTTP ID", + "description": "Project identifier as understood by the HTTP API", + "oneOf": [ + { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + } + ] + }, + "automation-studio_projects-http": { + "title": "Project HTTP Data", + "description": "Project data as it is sent back from get and search endpoints", + "type": "object", + "additionalProperties": false, + "required": [], + "properties": { + "_id": { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "name": { + "description": "Project name", + "type": "string", + "examples": [ + "Firewall Service Provisioning", + "Arista EOS Utilities", + "Github" + ] + }, + "description": { + "title": "Project description", + "description": "A free-form block of text for describing project intent and function", + "type": "string", + "examples": [ + "This project is used at Acme Corp as the foundation of some major parts of our business process.", + "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" + ] + }, + "members": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": ["type", "reference", "role"], + "properties": { + "type": { + "type": "string", + "enum": ["account", "group"] + }, + "reference": { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "role": { + "type": "string", + "enum": ["owner", "editor", "operator", "viewer"] + }, + "missing": { + "type": "boolean" + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + } + } + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + }, + "componentIidIndex": { + "title": "Component IID Index", + "description": "Read-only property providing incrementing integer ID values for child components within a project", + "type": "integer", + "minimum": 0 + }, + "components": { + "title": "Project components", + "description": "A list of member components in the project", + "type": "array", + "items": { + "title": "Project component", + "description": "An IAP component which resides within a project", + "type": "object", + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string", + "examples": [ + "1Ac4B2268489019745B5baa4", + "2D772A00dd2Ccedf3bd313bd", + "866a9B98DdD58Ff0e14ebB16" + ] + }, + "folder": { + "title": "Project component folder", + "description": "", + "type": "string", + "pattern": "^/" + } + } + } + }, + "folders": { + "title": "Project folders", + "description": "A list of folders and their members", + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "required": ["name", "nodeType", "children"], + "properties": { + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "name": { + "description": "Folder name", + "type": "string", + "examples": ["folder-1", "folder-2"] + }, + "children": { + "type": "array", + "items": { + "oneOf": [ + {}, + { + "type": "object", + "required": ["iid", "nodeType"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string" + } + } + } + ] + } + } + } + }, + { + "type": "object", + "required": ["iid", "nodeType"], + "properties": { + "iid": { + "title": "IID", + "description": "Incrementing integer ID", + "type": "integer", + "minimum": 0, + "examples": [1, 2, 3, 4, 5] + }, + "nodeType": { + "title": "Project folder node type", + "description": "String denoting the nodeType of the folder node", + "type": "string", + "enum": ["folder", "component"] + }, + "type": { + "title": "Project component type", + "description": "String denoting the type of component", + "type": "string", + "enum": [ + "workflow", + "jsonForm", + "mopAnalyticTemplate", + "mopCommandTemplate", + "template", + "transformation" + ] + }, + "reference": { + "type": "string" + } + } + } + ] + } + }, + "created": { + "title": "ISO Date String", + "description": "ISO Date String", + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "createdBy": {}, + "lastUpdated": { + "title": "ISO Date String", + "description": "ISO Date String", + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "lastUpdatedBy": {}, + "versionHistory": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": [ + "versionNumber", + "commitMessage", + "author", + "branchName" + ], + "properties": { + "versionNumber": { + "type": "integer", + "examples": [1] + }, + "commitMessage": { + "type": "string" + }, + "author": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + } + } + } + }, + "gitConfiguration": { + "type": "object", + "additionalProperties": false, + "required": [ + "connectionType", + "repositoryPath", + "branchName", + "projectPath" + ], + "properties": { + "connectionType": { + "type": "string", + "enum": ["GitHub", "GitLab"] + }, + "repositoryPath": { + "type": "string", + "examples": ["Itential Open Source"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + }, + "projectPath": { + "type": "string", + "examples": ["Projects"] + } + } + } + } + }, + "automation-studio_projects-search-parameters": { + "title": "Project Search Parameters", + "description": "Parameters used to filter and paginate Project documents in the Project search API", + "type": "object", + "additionalProperties": true, + "properties": { + "equals": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "iid": { + "type": "number" + }, + "name": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "lastUpdatedBy": { + "type": "string" + } + } + }, + "in": { + "type": "object", + "properties": { + "_id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "iid": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "name": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "createdBy": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + } + }, + "starts-with": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "contains": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "name,description": { + "type": "string" + }, + "description,name": { + "type": "string" + } + } + }, + "sort": { + "type": "string", + "enum": [ + "_id", + "iid", + "name", + "created", + "lastUpdated", + "createdBy", + "lastUpdatedBy" + ] + }, + "order": { + "type": "string", + "enum": ["asc", "desc"] + }, + "skip": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "limit": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + } + } + }, + "automation-studio_projects-update-data": { + "title": "Project Update Data", + "description": "PATCH body properties used to update a project", + "type": "object", + "additionalProperties": true, + "properties": { + "name": { + "description": "Project name", + "type": "string", + "examples": [ + "Firewall Service Provisioning", + "Arista EOS Utilities", + "Github" + ] + }, + "description": { + "title": "Project description", + "description": "A free-form block of text for describing project intent and function", + "type": "string", + "examples": [ + "This project is used at Acme Corp as the foundation of some major parts of our business process.", + "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" + ] + }, + "thumbnailBackgroundColor": { + "description": "Thumbnail background color", + "type": "string", + "default": "#FFFFFF" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "required": ["type", "reference", "role"], + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": ["account", "group"] + }, + "reference": { + "title": "MongoDB ObjectId", + "description": "A string representation of a MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": [ + "62a1f3d2ebedfc54e6e0065c", + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + }, + "role": { + "type": "string", + "enum": ["owner", "editor", "operator", "viewer"] + } + } + } + }, + "version": { + "type": "object", + "additionalProperties": false, + "required": [ + "versionNumber", + "commitMessage", + "author", + "branchName" + ], + "properties": { + "versionNumber": { + "type": "integer", + "examples": [1] + }, + "commitMessage": { + "type": "string" + }, + "author": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + } + } + }, + "gitConfiguration": { + "type": "object", + "additionalProperties": false, + "required": [ + "connectionType", + "repositoryPath", + "branchName", + "projectPath" + ], + "properties": { + "connectionType": { + "type": "string", + "enum": ["GitHub", "GitLab"] + }, + "repositoryPath": { + "type": "string", + "examples": ["Itential Open Source"] + }, + "branchName": { + "type": "string", + "examples": ["master"] + }, + "projectPath": { + "type": "string", + "examples": ["Projects"] + } + } + } + } + }, + "automation-studio_resource-ref-http": { + "title": "ResourceRef HTTP Data", + "description": "The resourceRef objects that are returned from getReferences", + "type": "object", + "additionalProperties": false, + "required": [ + "resourceType", + "resourcePointer", + "resourceId", + "parents" + ], + "properties": { + "resourceType": { + "type": "string" + }, + "resourcePointer": { + "type": "string" + }, + "resourceId": { + "type": "string" + }, + "root": { + "type": "boolean" + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "required": [ + "resourceType", + "resourcePointer", + "resourceId", + "parentPointer" + ], + "properties": { + "resourceType": { + "type": "string" + }, + "resourcePointer": { + "type": "string" + }, + "resourceId": { + "type": "string" + }, + "root": { + "type": "boolean" + }, + "parentPointer": { + "type": "string" + } + } + } + }, + "resource": { + "type": "object", + "description": "When using 'includeResources', this property will contain the full resource object" + } + } + }, + "automation-studio_taskDetails": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "title": "The Root Schema", + "required": ["location", "name", "app", "variables"], + "properties": { + "location": { + "type": "string", + "enum": ["Application", "Adapter", "Broker"] + }, + "name": { + "type": "string", + "examples": ["query"] + }, + "app": { + "type": "string", + "examples": ["WorkFlowEngine"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "string", + "number", + "array", + "object", + "enum", + "boolean", + "*" + ] + }, + "description": { + "type": "string", + "examples": ["Example description"] + }, + "schema": { + "type": "object" + } + } + } + }, + "outgoing": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "string", + "number", + "array", + "object", + "enum", + "boolean", + "*" + ] + }, + "description": { + "type": "string", + "examples": ["Example description"] + }, + "schema": { + "type": "object" + } + } + } + } + } + } + } + }, + "automation-studio_template": { + "title": "Template Document", + "description": "An entity representing a data template.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the automation" + }, + "namespace": { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + }, + "name": { + "type": "string", + "examples": ["arista_eos_show_clock"], + "minLength": 1, + "pattern": "^(?!\\s)[\\w\\s]+(? Record\n" + ], + "minLength": 1 + }, + "data": { + "type": "string", + "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], + "minLength": 1 + }, + "type": { + "type": "string", + "examples": ["textfsm", "jinja2"], + "enum": ["textfsm", "jinja2"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the automation" + }, + "created": { + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "lastUpdatedBy": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the automation" + }, + "lastUpdated": { + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "description": "A user-defined object to help group documents.", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "description": "Unique identifier of the automation" + }, + "name": { + "type": "string", + "description": "user-given, unique string to ID tag" + } + } + } + } + }, + "required": [ + "name", + "group", + "command", + "description", + "template", + "data", + "type" + ], + "additionalProperties": false + }, + "automation-studio_templateImport": { + "title": "Template Import Data", + "description": "Data to import as a new template document.", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "Unique identifier of the automation" + }, + "name": { + "type": "string", + "examples": ["arista_eos_show_clock"], + "minLength": 1 + }, + "projectId": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$" + } + ] + }, + "group": { + "type": "string", + "examples": ["Arista"], + "minLength": 1 + }, + "device": { + "type": "string", + "examples": ["Arista EOS"], + "minLength": 1 + }, + "command": { + "type": "string", + "examples": ["show clock"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["Arista Show Clock Info"], + "minLength": 1 + }, + "template": { + "type": "string", + "examples": [ + "Value TIME (d+:d+:d+)\nValue TIMEZONE (S+)\nValue DAYWEEK (w+)\nValue MONTH (w+)\nValue DAY (d+)\nValue YEAR (d+)\n\nStart\n ^${DAYWEEK}s+${MONTH}s+${DAY}s+${TIME}s+${YEAR}\n ^[t|T]imezone(:|sis)s+${TIMEZONE} -> Record\n" + ], + "minLength": 1 + }, + "data": { + "type": "string", + "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], + "minLength": 1 + }, + "text": { + "type": "string", + "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], + "minLength": 1 + }, + "type": { + "type": "string", + "examples": ["textfsm", "jinja2"], + "enum": ["textfsm", "jinja2"] + }, + "createdBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "Unique identifier of the automation" + }, + "created": { + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "lastModifiedBy": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "Unique identifier of the automation" + }, + "lastUpdated": { + "type": "string", + "examples": ["2019-11-25T22:51:39.201Z"], + "format": "date-time" + }, + "version": { + "type": "number", + "examples": [1], + "minimum": 1 + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "description": "A user-defined object to help group documents.", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "description": "Unique identifier of the automation" + }, + "name": { + "type": "string", + "description": "user-given, unique string to ID tag" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "_id", + "name", + "group", + "command", + "description", + "template", + "data", + "type" + ] + }, + { + "required": [ + "_id", + "name", + "device", + "command", + "template", + "text", + "type" + ] + } + ], + "additionalProperties": false + }, + "automation-studio_templateUpdate": { + "title": "Template Update", + "description": "An entity representing an update to an existing template document.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["arista_eos_show_clock"], + "minLength": 1 + }, + "group": { + "type": "string", + "examples": ["Arista"], + "minLength": 1 + }, + "projectId": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$" + } + ] + }, + "command": { + "type": "string", + "examples": ["show clock"], + "minLength": 1 + }, + "description": { + "type": "string", + "examples": ["Arista Show Clock Info"], + "minLength": 1 + }, + "template": { + "type": "string", + "examples": [ + "Value TIME (d+:d+:d+)\nValue TIMEZONE (S+)\nValue DAYWEEK (w+)\nValue MONTH (w+)\nValue DAY (d+)\nValue YEAR (d+)\n\nStart\n ^${DAYWEEK}s+${MONTH}s+${DAY}s+${TIME}s+${YEAR}\n ^[t|T]imezone(:|sis)s+${TIMEZONE} -> Record\n" + ], + "minLength": 1 + }, + "data": { + "type": "string", + "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], + "minLength": 1 + }, + "type": { + "type": "string", + "examples": ["textfsm", "jinja2"], + "enum": ["textfsm", "jinja2"] + } + }, + "required": [ + "name", + "group", + "command", + "description", + "template", + "data", + "type" + ], + "additionalProperties": false + }, + "automation-studio_workflowDocument": { + "title": "workflow document", + "description": "Third generation workflow document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "namespace": { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + }, + "name": { + "type": "string", + "examples": [ + "Port Turn Up IOS", + "Push Config to Device", + "Command Template Runner" + ] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "string", + "examples": ["Port Turn Up IOS", "Push Config to Device"] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "integer", + "title": "Pre automation time of automation", + "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", + "examples": [5000, 250000] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "workflow_end": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [0] + } + } + } + } + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "sla": { + "type": "integer", + "title": "Task SLA", + "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", + "examples": ["3600000"] + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + } + }, + "required": ["incoming", "outgoing", "error"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + }, + "retrySettings": { + "type": "object", + "title": "Retry Settings", + "description": "Retry settings for a task.", + "required": [ + "state", + "autoRetry", + "limit", + "delay" + ], + "properties": { + "state": { + "type": "array", + "title": "State", + "description": "Finish states the task will retry on. The task will retry on any of the included states.", + "items": { + "type": "string", + "enum": ["success", "error", "failure"] + } + }, + "autoRetry": { + "type": "boolean", + "title": "Auto Retry", + "description": "Whether the task is set to retry automatically or manually." + }, + "limit": { + "type": "integer", + "title": "Limit", + "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", + "examples": [10, 20] + }, + "delay": { + "type": "integer", + "title": "Delay", + "description": "Delay between each retry in milliseconds.", + "examples": [1000, 2000] + }, + "count": { + "type": "integer", + "title": "Count", + "description": "Current retry count used for workflow engine job processing", + "examples": [5] + } + }, + "additionalProperties": false + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": {}, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": {}, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "canvasVersion": { + "type": "number", + "const": 3 + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + } + }, + "additionalProperties": false, + "required": [ + "name", + "type", + "tasks", + "transitions", + "groups", + "canvasVersion" + ] + }, + "automation-studio_workflowDocumentAll": { + "title": "workflow document", + "description": "Accepts all generation workflow documents", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + "name": { + "type": "string", + "examples": [ + "Port Turn Up IOS", + "Push Config to Device", + "Command Template Runner" + ] + }, + "type": { + "type": "string", + "default": "automation" + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "additionalProperties": false, + "required": ["type", "_id", "name", "accessControl"], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "description": "A MongoDB ObjectId", + "type": "object" + }, + "name": { + "type": "string", + "examples": ["Juniper JUNOS", "F5 Big-IP"] + }, + "accessControl": { + "type": "object", + "additionalProperties": false, + "required": ["read", "write", "execute", "manage"], + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["account:67d3108eddcf3e66cc0efbac"] + } + } + } + } + } + } + ] + }, + "description": { + "oneOf": [ + { + "type": "string", + "examples": ["Port Turn Up IOS", "Push Config to Device"] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "number", + "examples": [5000, 250000] + }, + "sla": { + "type": "number", + "examples": [10] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + } + }, + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + } + ] + }, + "workflow_end": { + "type": "object", + "allOf": [ + { + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + } + }, + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string" + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "anyOf": [ + { + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasVersion: 1 workflows", + "examples": [1] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasVersion: 1 workflows", + "examples": [0] + } + } + }, + { + "properties": { + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + } + } + }, + { + "properties": { + "nodeLocation": { + "type": "object", + "description": "Stores the coordinates used by canvasVersion: 3 workflows", + "properties": { + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "additionalProperties": false + }, + "errorHandler": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + ] + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["name", "provenance"] + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": { + "oneOf": [ + { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["username", "provenance"] + }, + { + "type": "null" + } + ] + }, + "createdVersion": { + "type": "string", + "examples": ["5.40.5-2021.1.72.0"] + }, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": { + "oneOf": [ + { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn", "Local AAA"] + } + }, + "required": ["username", "provenance"] + }, + { + "type": "null" + } + ] + }, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": ["_id", "name", "description"] + } + }, + "canvasVersion": { + "type": "number", + "enum": [1, 1.5, 2, 3] + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + }, + "inputSchema": { + "type": "object" + }, + "outputSchema": { + "type": "object" + }, + "outputData": { + "type": "object" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "migrationVersion": { + "type": "integer", + "minimum": 0 + } + }, + "additionalProperties": true, + "required": ["name", "type", "tasks", "transitions", "groups"] + }, + "tags_tagDocument_tagName": { + "type": "string", + "examples": ["My Tag"] + }, + "tags_tagDocument_tagId": { + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + }, + "tags_tagDocument_tagDescription": { + "type": "string", + "examples": ["Descriptions can be empty"] + }, + "tags_tagDocument_contentRefId": { + "type": "string", + "examples": ["The id of the content to be referenced"] + }, + "tags_tagDocument_contentRefType": { + "type": "string", + "examples": ["The id of the content to be referenced"] + }, + "tags_tagDocument_tagObject": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + }, + "description": { + "type": "string", + "examples": ["Descriptions can be empty"] + }, + "name": { + "type": "string", + "examples": ["My Tag"] + } + } + }, + "tags_tagDocument_referenceObject": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["new created reference id"] + }, + "tag_id": { + "type": "string", + "examples": ["5c8fa48dd8e04500b1b2f28c"] + }, + "ref_id": { + "type": "string", + "examples": ["The id of the content to be referenced"] + }, + "type": { + "type": "string", + "examples": ["The id of the content to be referenced"] + } + } + }, + "workflow_engine_jobMetricsDocument": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "title": "Job metrics schema", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "workflow": { + "type": "object", + "title": "Automation the job was started on.", + "properties": { + "name": { + "type": "string", + "title": "Name of the automation the job was started on", + "examples": ["exampleAutomationName"] + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "Automation objectId the job was started on", + "examples": [ + "4321abcdef694aa79dae47ad", + "5cb7b531d06cceb89fd21b1c" + ] + } + } + }, + "preAutomationTime": { + "type": "integer", + "title": "Pre automation time of automation", + "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", + "examples": [5000, 250000] + }, + "metrics": { + "type": "array", + "title": "Weekly aggregate metrics", + "description": "Aggregate job metrics collected on a weekly basis", + "items": { + "type": "object", + "properties": { + "jobsComplete": { + "type": "integer", + "title": "Jobs complete for automation", + "description": "Total number of jobs complete for automation for the week starting at startDate.", + "minimum": 0, + "examples": [10, 40] + }, + "totalRunTime": { + "type": "integer", + "title": "Total run time for automation", + "description": "Total run time (milliseconds) of jobs complete for automation for the week starting at startDate.", + "minimum": 0, + "examples": [200, 700] + }, + "totalManualTime": { + "type": "integer", + "title": "Total manual time for automation", + "description": "Total time (milliseconds) spent working manual a task for automation for the week starting at startDate.", + "minimum": 0, + "examples": [200, 700] + }, + "slaTargetsMissed": { + "type": "integer", + "title": "Sla targets missed for automation.", + "description": "Total number of sla targets that were missed for an automation for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + }, + "startDate": { + "type": "string", + "title": "Start DateTime of metric collection", + "description": "Metrics are collected on a weekly interval, starting at startDate", + "examples": [ + "2018-08-02T15:56:12.912Z", + "2019-09-06T12:52:24.933Z" + ] + } + }, + "required": [ + "jobsComplete", + "totalRunTime", + "totalManualTime", + "slaTargetsMissed", + "startDate" + ] + } + } + }, + "required": ["_id", "workflow", "metrics"] + }, + "workflow_engine_taskMetricsDocument": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "title": "Default metrics schema", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "app": { + "type": "string", + "title": "The associated app for this task", + "examples": ["WorkflowBuilder"] + }, + "name": { + "type": "string", + "title": "The name of the task", + "examples": ["getTime", "testTask"] + }, + "taskType": { + "type": "string", + "title": "The type of the task", + "enum": ["automatic", "manual", "operation"] + }, + "global": { + "type": "boolean", + "title": "Global task", + "description": "Global designating if metric is global across automations or per-automation.", + "examples": [true, false] + }, + "taskId": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$|^workflow_start$|^workflow_end$", + "title": "Workflow task id", + "description": "Four character hexadecimal task identifier", + "examples": ["12ab", "cd34"] + }, + "workflow": { + "type": "object", + "title": "Automation the job was started on.", + "properties": { + "name": { + "type": "string", + "title": "Name of the automation the job was started on", + "examples": ["exampleAutomationName"] + } + } + }, + "metrics": { + "type": "array", + "title": "Weekly aggregate metrics", + "description": "Aggregate job metrics collected on a weekly basis", + "items": { + "type": "object", + "properties": { + "startDate": { + "type": "string", + "title": "Start DateTime of metric collection", + "description": "Metrics are collected on a weekly interval, starting at startDate.", + "examples": ["2018-08-02T15:56:12.912Z"] + }, + "totalSuccesses": { + "type": "integer", + "title": "Total successes for a task", + "description": "Total number of tasks that ended in status success for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + }, + "totalSuccessRunTime": { + "type": "integer", + "title": "Total successes run time for a task", + "description": "Total run time (milliseconds) for tasks that ended in status success for the week starting at startDate.", + "minimum": 0, + "examples": [550, 200] + }, + "totalErrors": { + "type": "integer", + "title": "Total errors for a task", + "description": "Total number of tasks that ended in status error for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + }, + "totalErrorRunTime": { + "type": "integer", + "title": "Total error run time for a task", + "description": "Total run time (milliseconds) for tasks that ended in status error for the week starting at startDate.", + "minimum": 0, + "examples": [550, 200] + }, + "totalFailures": { + "type": "integer", + "title": "Total failures for a task", + "description": "Total number of tasks that ended in status failure for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + }, + "totalFailureRunTime": { + "type": "integer", + "title": "Total failure run time for a task", + "description": "Total run time (milliseconds) for tasks that ended in status failure for the week starting at startDate.", + "minimum": 0, + "examples": [550, 200] + }, + "slaTargetsMissed": { + "type": "integer", + "title": "Sla targets missed for a manual task", + "description": "Total number of sla targets that were missed for a manual task for the week starting at startDate.", + "minimum": 0, + "examples": [5, 10] + } + }, + "required": [ + "startDate", + "totalSuccesses", + "totalSuccessRunTime", + "totalErrorRunTime", + "totalErrors", + "totalFailureRunTime", + "totalFailures" + ] + } + } + }, + "required": [ + "_id", + "app", + "name", + "type", + "taskType", + "global", + "metrics" + ] + }, + "workflow_engine_wfEngineCommon_skip": { + "type": "integer", + "description": "The number of documents skipped before returning data. When 0, no data is skipped.", + "minimum": 0, + "examples": [0] + }, + "workflow_engine_wfEngineCommon_limit": { + "type": "integer", + "title": "The returned document limit", + "description": "Specifies a limit to the maximum number of data results returned.", + "minimum": 0, + "maximum": 100, + "examples": [50] + }, + "workflow_engine_wfEngineCommon_sort": { + "type": "string", + "description": "Field to sort by. Default is workflow.name.", + "default": "workflow.name" + }, + "workflow_engine_wfEngineCommon_order": { + "type": "integer", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "default": 1, + "enum": [-1, 1] + }, + "workflow_engine_wfEngineCommon_total": { + "type": "integer", + "description": "The total number of documents returned from a search.", + "minimum": 0, + "examples": [100] + }, + "workflow_engine_wfEngineCommon_evaluationItem": { + "type": "object", + "title": "Evaluation Object", + "description": "Contains all the items/properties needed for a comparison operation/evaluation", + "required": ["operand_1", "operator", "operand_2"], + "properties": { + "query": { + "type": "string", + "title": "Query for first operand", + "description": "Query the operand_1 (optional)", + "examples": [ + "somePropertyNameInOperand_1IfItIsAnObject.nestedProperty" + ] + }, + "rightQuery": { + "type": "string", + "title": "Query for second operand", + "description": "Query the operand_2 (optional)", + "examples": [ + "somePropertyNameInOperand_2IfItIsAnObject.nestedProperty" + ] + }, + "operand_1": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "boolean" + }, + { + "type": "number" + } + ], + "title": "A comparison value", + "description": "Used in evaluations as either the object to compare, or the object to compare to" + }, + "operator": { + "type": "string", + "enum": ["contains", "!contains", "<", "<=", ">", ">=", "==", "!="], + "title": "The Operator ", + "description": "The operation (contains, !contains, <,<=, etc)", + "examples": ["contains"] + }, + "operand_2": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "boolean" + }, + { + "type": "number" + } + ], + "title": "A comparison value", + "description": "Used in evaluations as either the object to compare, or the object to compare to" + } + } + }, + "workflow_engine_wfEngineCommon_mongoObjectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$", + "title": "MongoDB ObjectID", + "description": "String representation of a MongoDB ObjectId", + "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] + }, + "json-forms_formBindingSchema_bindingSchema": { + "type": "object" + }, + "json-forms_formDocument_form": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2019-04-16T00:43:22.038Z"] + }, + "createdBy": { + "type": "string", + "examples": ["5cb08d4f16640f00182c3890"] + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "examples": ["2019-04-16T00:43:22.038Z"] + }, + "lastUpdatedBy": { + "type": "string", + "examples": ["5cb08d4f16640f00182c3890"] + }, + "name": { + "type": "string", + "examples": ["Device Form"] + }, + "tags": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + { + "type": "object" + } + ] + } + }, + "description": { + "anyOf": [ + { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + { + "type": "null" + } + ] + }, + "struct": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "projectId": { + "type": "string" + }, + "type": { + "type": "string" + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "array" + } + ] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "This section describes the connection information for a device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": [ + "Enter connection retry attempt count" + ] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + }, + "collapsed": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "schemaOption": { + "type": "boolean" + }, + "combinationType": { + "type": "string" + }, + "widget": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "items"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "required": ["type", "items"], + "additionalProperties": false, + "definitions": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "container": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "array" + } + ] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "This section describes the connection information for a device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "array" + } + ] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "This section describes the connection information for a device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": [ + "Enter connection retry attempt count" + ] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": [ + "Tooltip help message goes here" + ] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + }, + "collapsed": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "schemaOption": { + "type": "boolean" + }, + "combinationType": { + "type": "string" + }, + "widget": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "items"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": [ + "Enter connection retry attempt count" + ] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + }, + "collapsed": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "schemaOption": { + "type": "boolean" + }, + "combinationType": { + "type": "string" + }, + "widget": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "items"], + "additionalProperties": false + }, + "checkboxField": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": ["Is a timeout allowed to pass this step?"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + }, + "numberField": { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + "textField": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + "textareaField": { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + "dropdownField": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + "fileUploadField": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + } + } + }, + "schema": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "readOnly": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file."] + }, + "format": { + "type": "string", + "const": "data-url" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": { + "type": "boolean" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + } + } + }, + "anyOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "oneOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "allOf": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["type", "title"] + }, + "uiSchema": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "ui:widget": { + "type": "string", + "const": "updown" + } + }, + "required": ["ui:widget"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's config"] + }, + "ui:widget": { + "type": "string", + "const": "textarea" + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Select device"] + } + } + } + ] + } + } + }, + "validationSchema": { + "type": "object" + }, + "bindingSchema": { + "type": "object" + }, + "version": { + "type": "string", + "examples": ["2020.1"] + }, + "id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + "required": [ + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy", + "name", + "description", + "struct", + "schema", + "uiSchema", + "bindingSchema", + "validationSchema", + "version" + ], + "additionalProperties": false + }, + "json-forms_formDocument_formId": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "json-forms_formDocument_formData": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + }, + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + } + }, + "json-forms_formDocument_validationResponse": { + "type": "object", + "properties": { + "status": { + "type": "integer", + "enum": [200, 404] + }, + "validation": { + "type": "object", + "properties": { + "valid": { + "type": "boolean" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "message": { + "type": "string", + "examples": ["Form data is valid."] + } + } + }, + "json-forms_formDocument_importResultReport": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2019-04-16T00:43:22.038Z"] + }, + "createdBy": { + "type": "string", + "examples": ["5cb08d4f16640f00182c3890"] + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "examples": ["2019-04-16T00:43:22.038Z"] + }, + "lastUpdatedBy": { + "type": "string", + "examples": ["5cb08d4f16640f00182c3890"] + }, + "name": { + "type": "string", + "examples": ["Device Form"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + } + } + }, + "json-forms_formSchema_container": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "readOnly": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "readOnly": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file."] + }, + "format": { + "type": "string", + "const": "data-url" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": { + "type": "boolean" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + } + } + } + }, + "anyOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "oneOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "allOf": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["type", "title"] + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": ["Is a timeout allowed to pass this step?"] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file."] + }, + "format": { + "type": "string", + "const": "data-url" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": { + "type": "boolean" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "description": { + "type": "string", + "examples": [ + "This form describes the connection information for a device." + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "readOnly": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "properties": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file."] + }, + "format": { + "type": "string", + "const": "data-url" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": [ + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + } + }, + "items": {}, + "anyOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "oneOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "allOf": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["type", "title"] + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "default": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + } + }, + "readOnly": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "minimum": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "default": { + "type": "number" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "placeholder": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "options": { + "type": "object" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "readOnly": { + "type": "boolean" + }, + "placeholder": { + "type": "string" + }, + "binding": { + "type": "boolean" + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + } + }, + "required": ["type", "title", "description"], + "additionalProperties": false + } + ] + } + } + } + } + }, + "anyOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "oneOf": { + "type": "array", + "items": { + "type": "object" + } + }, + "allOf": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": ["type", "title"] + }, + "json-forms_formStruct": { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "projectId": { + "type": "string" + }, + "type": { + "type": "string" + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Connection Information"] + }, + "required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "array" + } + ] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "This section describes the connection information for a device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "items": { + "type": "array", + "items": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": [ + "Is a timeout allowed to pass this step?" + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": [ + "Enter connection retry attempt count" + ] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": [ + "A unique name of the target device." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "nodeId", + "type", + "title", + "description" + ], + "additionalProperties": false + } + ] + } + }, + "collapsed": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + }, + "schemaOption": { + "type": "boolean" + }, + "combinationType": { + "type": "string" + }, + "widget": { + "type": "string" + }, + "uniqueItems": { + "type": "boolean" + }, + "minItems": { + "type": "number" + }, + "maxItems": { + "type": "number" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "items"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "type": { + "type": "string", + "const": "boolean" + }, + "required": { + "type": "boolean" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Allow timeout"] + }, + "description": { + "type": "string", + "examples": ["Is a timeout allowed to pass this step?"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "default": { + "type": "boolean", + "examples": [false] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "boolean" + } + } + } + }, + "readOnly": { + "type": "boolean" + }, + "widget": { + "type": "string" + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "number" + }, + "widget": { + "type": "string" + }, + "options": { + "type": "object" + }, + "title": { + "type": "string", + "examples": ["Retry attempts"] + }, + "description": { + "type": "string", + "examples": [ + "The number of connection retries before timing out." + ] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "required": { + "type": "boolean" + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "minimum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "maximum": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "default": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "binding": { + "type": "boolean" + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "widget": { + "type": "string" + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "minLength": { + "type": "integer" + }, + "maxLength": { + "type": "integer" + }, + "default": { + "type": "string" + }, + "disabled": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "placeholder", + "required" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "title": { + "type": "string", + "examples": ["Device Name"] + }, + "options": { + "type": "object" + }, + "description": { + "type": "string", + "examples": ["A unique name of the target device."] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + }, + "required": { + "type": "boolean" + }, + "enum": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "default": [] + }, + "enumNames": { + "type": "array", + "items": { + "type": "object" + }, + "default": [] + }, + "binding": { + "type": "boolean", + "default": false + }, + "pattern": { + "type": "string", + "examples": ["regex"] + }, + "rel": { + "type": "string" + }, + "targetPointer": { + "type": "string" + }, + "method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["GET"] + }, + "body": { + "type": "object" + }, + "sourcePointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/"] + }, + "sourceKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "labelKeyPointer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["/name"] + }, + "base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["http://www.google.com/"] + }, + "href": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "examples": ["api/v1/devices"] + }, + "validation": { + "type": ["object", "array"] + }, + "readOnly": { + "type": "boolean" + }, + "transformation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "disabled": { + "type": "boolean" + }, + "default": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "widget": { + "type": "string" + }, + "radio": { + "type": "boolean" + }, + "inline": { + "type": "boolean" + } + }, + "required": [ + "nodeId", + "type", + "title", + "description", + "required" + ] + }, + { + "type": "object", + "properties": { + "nodeId": { + "type": "string", + "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] + }, + "type": { + "type": "string", + "const": "string" + }, + "title": { + "type": "string", + "examples": ["File Upload"] + }, + "description": { + "type": "string", + "examples": ["Upload a file"] + }, + "helper": { + "type": "string", + "examples": ["Tooltip help message goes here"] + }, + "required": { + "type": "boolean" + }, + "format": { + "type": "string", + "const": "data-url" + }, + "customKey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "required": ["nodeId", "type", "title", "description"], + "additionalProperties": false + } + ] + } + } + }, + "required": ["type", "items"], + "additionalProperties": false + }, + "json-forms_formUISchema_container": { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + { + "type": "object", + "patternProperties": { + ".*": { + "anyOf": [ + {}, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "ui:widget": { + "type": "string", + "const": "updown" + } + }, + "required": ["ui:widget"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's config"] + }, + "ui:widget": { + "type": "string", + "const": "textarea" + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Select device"] + } + } + } + ] + } + } + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter connection retry attempt count"] + }, + "ui:widget": { + "type": "string", + "const": "updown" + } + }, + "required": ["ui:widget"], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's name"] + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Enter the device's config"] + }, + "ui:widget": { + "type": "string", + "const": "textarea" + } + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ui:placeholder": { + "type": "string", + "examples": ["Select device"] + } + } + } + ] + } + } + }, + "json-forms_formValidationSchema_validationSchema": { + "type": "object" + }, + "json-forms_metaSchema": { + "oneOf": [ + { + "type": "boolean", + "default": true + }, + { + "type": "object", + "properties": { + "$id": { + "type": "string", + "format": "uri-reference" + }, + "$schema": { + "type": "string", + "format": "uri" + }, + "$ref": { + "type": "string", + "format": "uri-reference" + }, + "$comment": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "default": {}, + "readOnly": { + "type": "boolean", + "default": false + }, + "examples": { + "type": "array", + "items": {} + }, + "multipleOf": { + "type": "number", + "exclusiveMinimum": 0 + }, + "maximum": { + "type": "number" + }, + "exclusiveMaximum": { + "type": "number" + }, + "minimum": { + "type": "number" + }, + "exclusiveMinimum": { + "type": "number" + }, + "maxLength": { + "type": "integer", + "minimum": 0 + }, + "minLength": { + "allOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "default": 0 + } + ] + }, + "pattern": { + "type": "string", + "format": "regex" + }, + "additionalItems": {}, + "items": { + "anyOf": [ + {}, + { + "type": "array", + "minItems": 1, + "items": {} + } + ], + "default": true + }, + "maxItems": { + "type": "integer", + "minimum": 0 + }, + "minItems": { + "allOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "default": 0 + } + ] + }, + "uniqueItems": { + "type": "boolean", + "default": false + }, + "contains": {}, + "maxProperties": { + "type": "integer", + "minimum": 0 + }, + "minProperties": { + "allOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "default": 0 + } + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "uniqueItems": true, + "default": [] + }, + "additionalProperties": {}, + "definitions": { + "type": "object", + "additionalProperties": {}, + "default": {} + }, + "properties": { + "type": "object", + "additionalProperties": {}, + "default": {} + }, + "patternProperties": { + "type": "object", + "additionalProperties": {}, + "propertyNames": { + "format": "regex" + }, + "default": {} + }, + "dependencies": { + "type": "object", + "additionalProperties": { + "anyOf": [ + {}, + { + "type": "array", + "items": { + "type": "string" + }, + "uniqueItems": true, + "default": [] + } + ] + } + }, + "propertyNames": {}, + "const": {}, + "enum": { + "type": "array", + "items": {}, + "minItems": 1, + "uniqueItems": true + }, + "type": { + "anyOf": [ + { + "enum": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + { + "type": "array", + "items": { + "enum": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "minItems": 1, + "uniqueItems": true + } + ] + }, + "format": { + "type": "string" + }, + "contentMediaType": { + "type": "string" + }, + "contentEncoding": { + "type": "string" + }, + "if": {}, + "then": {}, + "else": {}, + "allOf": { + "type": "array", + "minItems": 1, + "items": {} + }, + "anyOf": { + "type": "array", + "minItems": 1, + "items": {} + }, + "oneOf": { + "type": "array", + "minItems": 1, + "items": {} + }, + "not": {} + } + } + ] + }, + "workflow_builder_workflowDocument": { + "title": "workflow document", + "description": "A workflow document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + "name": { + "type": "string", + "examples": ["My Workflow"] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + } + } + } + } + } + ] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + }, + "workflow_end": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "x": { + "type": "number", + "examples": [10] + }, + "y": { + "type": "number", + "examples": [20] + } + } + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "additionalProperties": false + }, + "errorHandler": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + ] + }, + "font_size": { + "type": "integer", + "default": 12, + "multipleOf": 2, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "created": { + "type": "string", + "format": "date-time" + }, + "created_by": {}, + "createdVersion": { + "type": "string", + "examples": ["5.40.5-2021.1.72.0"] + }, + "last_updated": { + "type": "string", + "format": "date-time" + }, + "last_updated_by": {}, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "canvasVersion": { + "type": "number", + "enum": [1, 1.5, 2, 3] + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + }, + "inputSchema": { + "type": "object" + }, + "outputSchema": { + "type": "object" + }, + "outputData": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "taskId": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$" + }, + "taskPointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "additionalProperties": false, + "required": ["name", "type", "tasks", "transitions", "groups"] + }, + "workflow_builder_workflowDocument_workflowName": { + "type": "string", + "examples": ["My Workflow"] + }, + "workflow_builder_workflowDocument_anyTask": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string", + "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + } + ] + }, + "workflow_builder_workflowPayload": { + "title": "workflow import payload", + "description": "A workflow import payload, that has expanded users and groups for transportation between environments", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + }, + "name": { + "type": "string", + "examples": ["ciscoIOSSoftwareUpgrade", "infobloxCreateARecord"] + }, + "type": { + "type": "string", + "default": "automation" + }, + "description": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": [ + "Upgrade Cisco IOS device", + "Infoblox Create A Record" + ] + } + ] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string", + "examples": ["New Relic", "Cisco", "AWS/EC2"] + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "execute": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "write": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + }, + "manage": { + "type": "array", + "items": { + "type": "string", + "examples": ["677c243acf96f9b4484a78ae"] + } + } + } + } + } + } + ] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_start$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_start$" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + }, + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [5] + } + } + }, + "workflow_end": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^workflow_end$" + }, + "summary": { + "type": "string", + "pattern": "^workflow_end$" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + }, + "x": { + "type": "number", + "examples": [1] + }, + "y": { + "type": "number", + "examples": [10] + } + } + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + }, + { + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "manual" + }, + "view": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": ["type", "view", "groups"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "automatic" + }, + "actor": { + "type": "string" + } + }, + "required": ["type", "actor"] + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows", + "examples": [0] + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows", + "examples": [100] + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number", + "examples": [0] + }, + "y": { + "type": "number", + "examples": [1] + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "Query", + "Transformation", + "Eval", + "Get Device", + "View Data" + ] + }, + "summary": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "description": { + "type": "string", + "examples": [ + "Query Data Using 'json-query' Format", + "JSON Transformation", + "View Data" + ] + }, + "app": { + "type": "string", + "examples": ["Tools", "WorkflowEngine", "Array"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + } + }, + "required": ["incoming", "outgoing"] + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + } + }, + "required": [ + "name", + "summary", + "description", + "app", + "variables", + "groups", + "x", + "y" + ] + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "operation" + } + }, + "required": ["type"] + } + ] + } + ] + } + }, + "required": ["workflow_start", "workflow_end"], + "additionalProperties": false + }, + "transitions": { + "type": "object", + "properties": { + "workflow_start": { + "type": "object" + }, + "workflow_end": { + "type": "object" + }, + "error_handler": { + "type": "object" + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "type": "object" + } + }, + "additionalProperties": false + }, + "errorHandler": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + ] + }, + "font_size": { + "type": "integer", + "default": 12, + "minimum": 6, + "maximum": 24 + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["Admin"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["name", "provenance"] + } + }, + "created": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "created_by": { + "oneOf": [ + { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["username", "provenance"] + }, + { + "type": "null" + } + ] + }, + "createdVersion": { + "type": "string", + "examples": ["5.40.5-2021.1.72.0"] + }, + "last_updated": { + "type": "string", + "format": "date-time", + "examples": ["2024-03-13T18:21:15.352Z"] + }, + "last_updated_by": { + "oneOf": [ + { + "type": "object", + "properties": { + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "provenance": { + "type": "string", + "examples": ["Pronghorn"] + } + }, + "required": ["username", "provenance"] + }, + { + "type": "null" + } + ] + }, + "lastUpdatedVersion": { + "type": "string", + "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", + "examples": ["4.69.69"] + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": ["_id", "name", "description"] + } + }, + "canvasVersion": { + "type": "number", + "enum": [1, 1.5, 2, 3] + }, + "encodingVersion": { + "type": "integer", + "enum": [1] + }, + "inputSchema": { + "type": "object" + }, + "outputSchema": { + "type": "object" + }, + "outputData": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "taskId": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$" + }, + "taskPointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["encryption"] + }, + "pointer": { + "type": "string", + "format": "json-pointer", + "examples": ["/outgoing/output"] + } + } + } + }, + "migrationVersion": { + "type": "integer", + "minimum": 0 + } + }, + "additionalProperties": false, + "required": ["name", "type", "tasks", "transitions", "groups"] + }, + "template_builder_parseTemplateInput": { + "title": "parse template input", + "description": "The text data to be parse and the textfsm template", + "type": "object", + "properties": { + "text": { + "type": "string", + "examples": ["hostname"] + }, + "template": { + "title": "template document", + "description": "A template document", + "type": "object", + "properties": { + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "name": { + "type": "string", + "examples": ["My Template"] + }, + "device": { + "type": "string", + "examples": ["Device Group A"] + }, + "command": { + "type": "string", + "examples": ["show hostname"] + }, + "template": { + "type": "string", + "examples": [ + "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record" + ] + }, + "text": { + "type": "string", + "examples": ["hostname"] + }, + "type": { + "type": "string", + "const": "custom" + } + }, + "required": [ + "name", + "device", + "command", + "template", + "text", + "type" + ], + "definitions": { + "templateName": { + "type": "string", + "examples": ["My Template"] + }, + "groupName": { + "type": "string", + "examples": ["Device Group A"] + }, + "command": { + "type": "string", + "examples": ["show hostname"] + }, + "template": { + "type": "string", + "examples": [ + "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record" + ] + }, + "text": { + "type": "string", + "examples": ["hostname"] + }, + "ObjectId": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + "required": ["text", "template"] + }, + "operations-manager_automation-api": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Automation Document", + "description": "An Automation document in API response format.", + "required": [ + "name", + "description", + "componentType", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "_id", + "gbac" + ], + "oneOf": [ + { + "required": ["componentId"], + "not": { + "required": ["componentName"] + } + }, + { + "required": ["componentName"], + "not": { + "required": ["componentId"] + } + }, + { + "required": ["componentId", "componentName"] + } + ], + "propertyNames": { + "anyOf": [ + { + "enum": ["name", "description", "componentType"] + }, + { + "enum": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] + }, + { + "enum": ["_id", "gbac", "componentName", "componentId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group ids that have write access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "read": { + "type": "array", + "description": "An array of group ids that have read/execute access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "componentId": { + "description": "The id of the component linked to this Automation.", + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + }, + { + "const": "" + } + ] + }, + "componentName": { + "description": "The name of the component linked to this Automation.", + "oneOf": [ + { + "type": "string", + "examples": ["addDuration", "getJobMetrics"] + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + "operations-manager_automation-common_commonFields": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + "operations-manager_automation-common_gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group ids that have write access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "read": { + "type": "array", + "description": "An array of group ids that have read/execute access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "operations-manager_automation-common_componentId": { + "description": "The id of the component linked to this Automation.", + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + }, + { + "const": "" + } + ] + }, + "operations-manager_automation-create": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Automation Create", + "description": "The format of accepted input for the creation of an Automation document.", + "required": ["name"], + "propertyNames": { + "anyOf": [ + { + "enum": ["name", "description", "componentType"] + }, + { + "enum": [ + "gbac", + "componentId", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy", + "componentName" + ] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group ids that have write access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "read": { + "type": "array", + "description": "An array of group ids that have read/execute access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "componentId": { + "description": "The id of the component linked to this Automation.", + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + }, + { + "const": "" + } + ] + } + } + } + ] + }, + "operations-manager_automation-json": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Automation Document", + "description": "An Automation document in JSON/export format.", + "required": [ + "name", + "description", + "componentType", + "_id", + "gbac", + "componentName" + ], + "propertyNames": { + "anyOf": [ + { + "enum": ["name", "description", "componentType"] + }, + { + "enum": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] + }, + { + "enum": ["_id", "gbac", "triggers", "componentName"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group objects that have write access to the Automation.", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "examples": ["ldap", "localAAA"] + }, + "name": { + "type": "string", + "examples": ["operators", "admins", "designers"] + }, + "description": { + "type": "string", + "examples": ["Description of a group"] + } + }, + "required": ["provenance", "name", "description"] + } + }, + "read": { + "type": "array", + "description": "An array of group objects that have read/execute access to the Automation.", + "items": { + "type": "object", + "properties": { + "provenance": { + "type": "string", + "examples": ["ldap", "localAAA"] + }, + "name": { + "type": "string", + "examples": ["operators", "admins", "designers"] + }, + "description": { + "type": "string", + "examples": ["Description of a group"] + } + }, + "required": ["provenance", "name", "description"] + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "triggers": { + "type": "array", + "items": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger", + "description": "An Endpoint Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "verb", + "routeName", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger", + "description": "An EventSystem Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "source", + "topic", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "source", + "topic", + "schema", + "legacyWrapper" + ] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger", + "description": "A Manual Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "formData", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper" + ] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Triggers Schema for JSON Representation", + "description": "Schema for a Schedule Trigger JSON representation", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "formData", + "firstRunAt", + "processMissedRuns", + "repeatUnit", + "repeatFrequency", + "repeatInterval", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": [ + "repeating", + "terminating" + ] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [ + 30, 140, 2000 + ] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [ + 10000, 30000, 100000 + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [ + 30, 140, 2000 + ] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [ + 10000, 30000, 100000 + ] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + } + }, + "componentName": { + "description": "The name of the component linked to this Automation.", + "oneOf": [ + { + "type": "string", + "examples": ["addDuration", "getJobMetrics"] + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + "operations-manager_automation-update": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Automation Updates", + "description": "The format of accepted input for an update operation on an Automation document.", + "propertyNames": { + "anyOf": [ + { + "enum": ["name", "description", "componentType"] + }, + { + "enum": [ + "gbac", + "componentId", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy", + "componentName" + ] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "componentType": { + "description": "The type of component linked to this Automation.", + "oneOf": [ + { + "const": "workflows" + }, + { + "const": "ucm_compliance_plans" + }, + { + "const": "resource_models" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "gbac": { + "type": "object", + "properties": { + "write": { + "type": "array", + "description": "An array of group ids that have write access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "read": { + "type": "array", + "description": "An array of group ids that have read/execute access to the Automation.", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "required": ["write", "read"], + "additionalProperties": false + }, + "componentId": { + "description": "The id of the component linked to this Automation.", + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + }, + { + "const": "" + } + ] + } + } + } + ] + }, + "operations-manager_common-api_pagination-metadata": { + "description": "Properties describing search result pagination", + "type": "object", + "properties": { + "skip": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "nextPageSkip": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "integer" + } + ] + }, + "previousPageSkip": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "integer" + } + ] + }, + "currentPageSize": { + "type": "integer" + } + } + }, + "operations-manager_common-api_success-response": { + "description": "A success response from an API method", + "type": "object", + "additionalProperties": false, + "required": ["message", "data", "metadata"], + "properties": { + "message": { + "description": "A human-readable message summarizing the result of the operation", + "type": "string", + "examples": [ + "Successfully created the requested item", + "Successfully imported 3 of 4 documents", + "Successfully retrieved search results", + "Successfully added group 679cebd0502a4abd9a57a6ba to job 13861e352afe454d89cccfb8", + "Successfully canceled all jobs" + ] + }, + "data": { + "description": "Any successfully retrieved information related to the request." + }, + "metadata": { + "description": "Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.", + "type": "object", + "additionalProperties": true + } + } + }, + "operations-manager_common-api_getJobsQueryParameters": { + "title": "getJobsQueryParameters", + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + }, + "skip": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + }, + "order": { + "type": "integer", + "description": "Sort direction, 1 for ascending and -1 for descending.", + "default": 1, + "enum": [-1, 1] + }, + "sort": { + "type": "string", + "description": "Field to sort by", + "default": "name", + "enum": ["name"] + }, + "include": { + "type": "string", + "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", + "examples": ["name", "description", "name,description"] + }, + "exclude": { + "type": "string", + "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", + "examples": ["_id", "description", "_id,description"] + }, + "in": { + "description": "Search for fields exactly matching one of the given list options", + "type": "string" + }, + "not-in": { + "description": "Search for fields not exactly matching one of the given list options", + "type": "string" + }, + "equals": { + "description": "Returns results where the specified fields exactly match the given match string(s).", + "type": "string" + }, + "contains": { + "description": "Returns results where the specified fields contain the given match string(s). When used on the 'description' field, returns results containing any matching whole word, delimited by most punctuation. Double-quotes may be used to match phrases rather than individual words.", + "type": "string" + }, + "starts-with": { + "description": "Returns results where the specified fields start with the given match string(s).", + "type": "string" + }, + "ends-with": { + "description": "Returns results where the specified fields end in the given match string(s).", + "type": "string" + }, + "dereference": { + "description": "Designates foreign key fields to dereference in the API output.", + "type": "string" + }, + "gt": { + "description": "Returns results where the specified fields have values greater than the specified values.", + "type": "string" + }, + "gte": { + "description": "Returns results where the specified fields have values greater than or equal to the specified values.", + "type": "string" + }, + "lt": { + "description": "Returns results where the specified fields have values less than the specified values.", + "type": "string" + }, + "lte": { + "description": "Returns results where the specified fields have values less than or equal to the specified values.", + "type": "string" + }, + "q": { + "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", + "type": "string" + }, + "exists": { + "description": "Returns results where the specified fields exist according to the specified value.", + "type": "string" + } + } + }, + "operations-manager_common-api_simplePluralSearchQueryParameters": { + "type": "object", + "properties": { + "contains": { + "type": "string", + "examples": ["event"], + "description": "The value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document" + }, + "containsField": { + "type": "string", + "examples": ["name"], + "description": "The field to run a contains query on" + }, + "equals": { + "type": "string", + "examples": ["my event trigger"], + "description": "The value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document" + }, + "equalsField": { + "type": "string", + "examples": ["name"], + "description": "The field to run an equals query on" + }, + "startsWith": { + "type": "string", + "examples": ["my"], + "description": "The value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document" + }, + "startsWithField": { + "type": "string", + "examples": ["name"], + "description": "The field to run a startsWith query on" + }, + "limit": { + "type": "integer", + "description": "Number of results to return. Used for pagination.", + "default": 25, + "minimum": 0, + "examples": [1, 10, 50] + }, + "skip": { + "type": "integer", + "description": "Number of results to skip. Used for pagination.", + "default": 0, + "minimum": 0, + "examples": [1, 10, 50] + }, + "order": { + "type": "integer", + "description": "The sort direction: 1 for ascending or -1 for descending.", + "default": 1, + "enum": [-1, 1] + }, + "sort": { + "type": "string", + "description": "Field to sort by. Default is name.", + "default": "name", + "enum": ["name"] + } + } + }, + "operations-manager_common_name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "operations-manager_common_ObjectIdLikeString": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "operations-manager_common_uuid-v4": { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + "operations-manager_common_decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "operations-manager_common_metadataFields": { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "operations-manager_eventSystem-trigger-common_source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "operations-manager_eventSystem-trigger-common_topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "operations-manager_job-api": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Job Document", + "description": "A Job document in API response format.", + "$comment": "No required fields, because projection operators can result in any combination of fields", + "required": [], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "_id", + "font_size", + "type", + "created", + "last_updated", + "createdVersion", + "lastUpdatedVersion", + "canvasVersion", + "encodingVersion", + "migrationVersion", + "name", + "description", + "preAutomationTime", + "sla", + "decorators", + "transitions", + "status", + "variables", + "tags", + "error", + "warnings", + "ancestors", + "validationErrors", + "namespace" + ] + }, + { + "enum": [ + "created_by", + "last_updated_by", + "tasks", + "parent", + "errorHandler", + "groups", + "watchers", + "metrics", + "output", + "outputData", + "errors", + "warnings" + ] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "font_size": { + "type": "integer", + "examples": [12, 13, 14] + }, + "type": { + "enum": ["automation", "resource:action", "resource:compliance"] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "last_updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "createdVersion": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$", + "examples": ["5.55.5"] + }, + "lastUpdatedVersion": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$", + "examples": ["5.55.6"] + }, + "canvasVersion": { + "enum": [1, 1.5, 2, 3] + }, + "encodingVersion": { + "enum": [1] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "oneOf": [ + { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + { + "type": "null" + } + ] + }, + "preAutomationTime": { + "type": "number", + "examples": [0] + }, + "sla": { + "type": "number", + "examples": [0] + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + }, + "transitions": { + "type": "object" + }, + "status": { + "enum": [ + "error", + "complete", + "running", + "canceled", + "incomplete", + "paused" + ] + }, + "variables": { + "type": "object", + "examples": [ + { + "initiator": { + "location": "job_data", + "_id": "67be20c2dda0df69ebe60826" + }, + "_id": { + "location": "job_data", + "_id": "67be20c2dda0df69ebe60825" + } + } + ] + }, + "tags": { + "type": "array" + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "const": "job" + }, + { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["workflow_start", "e28f", "3a1f"] + } + ] + } + ] + }, + "message": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + } + ] + }, + "timestamp": { + "type": "number", + "description": "The time at which this error occurred, designated by a unix timestamp" + } + }, + "examples": [ + { + "task": "f9a9", + "message": { + "code": 500, + "message": { + "apiVersion": "1", + "method": "transformations.run", + "error": { + "code": 500, + "message": "Missing one of the following required instances: arg2, arg1", + "errors": [{}] + } + } + }, + "timestamp": 1627323002561 + }, + { + "task": "job", + "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", + "timestamp": 1627323002574 + } + ] + } + }, + "warnings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["workflow_start", "e28f", "3a1f"] + } + ] + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "message": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + } + ] + } + } + } + }, + "ancestors": { + "oneOf": [ + { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "type": "null" + } + ] + }, + "validationErrors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "keyword": { + "type": "string" + }, + "instancePath": { + "type": "string" + }, + "schemaPath": { + "type": "string" + }, + "params": { + "type": "object" + }, + "message": { + "type": "string" + } + } + } + }, + "namespace": { + "type": "object" + } + } + }, + { + "type": "object", + "properties": { + "created_by": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + "last_updated_by": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + "tasks": { + "type": "object", + "properties": { + "workflow_start": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "workflow_start" + }, + "summary": { + "const": "workflow_start" + }, + "taskId": { + "const": "workflow_start" + }, + "metrics": { + "type": "object", + "properties": { + "start_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "metrics": { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + } + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + }, + "workflow_end": { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "workflow_end" + }, + "summary": { + "const": "workflow_end" + }, + "taskId": { + "const": "workflow_end" + }, + "endTasks": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "metrics": { + "type": "object", + "properties": { + "end_time": { + "type": "number" + }, + "run_time": { + "type": "number" + } + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + }, + "error_handler": { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "operation" + }, + "canvasName": { + "not": { + "const": "childJob" + } + } + } + } + ] + }, + { + "type": "object", + "properties": { + "name": { + "const": "childJob" + } + } + } + ] + }, + { + "type": "object", + "properties": { + "actor": { + "oneOf": [ + { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + { + "const": "job" + } + ] + }, + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + } + }, + "patternProperties": { + "^[0-9a-f]{1,4}$": { + "allOf": [ + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "view": { + "type": "string" + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "automatic" + }, + "actor": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "const": "job" + }, + { + "$comment": "Job variable", + "type": "string", + "pattern": "^\\$var\\.job\\.[a-zA-Z_0-9]{1,}$" + }, + { + "$comment": "Task reference", + "type": "string", + "pattern": "^\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + } + ] + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "operation" + }, + "canvasName": { + "not": { + "const": "childJob" + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "canvasName": { + "const": "childJob" + }, + "loop": { + "type": "object", + "properties": { + "atLeastOneComplete": { + "type": "boolean" + }, + "finishedCount": { + "type": "number" + }, + "isFinished": { + "type": "object", + "additionalProperties": false, + "patternProperties": { + "^[0-9a-fA-F]{24}$": { + "type": "boolean" + } + } + }, + "outgoing": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "childJobLoopIndex": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "value": { + "type": "integer" + } + } + }, + "_id": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "_id": { + "type": "string" + } + } + }, + "initiator": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "_id": { + "type": "string" + } + } + } + } + }, + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + }, + "childJobs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "iteration": { + "type": "number" + } + } + } + } + } + } + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor": { + "oneOf": [ + { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + { + "const": "job" + } + ] + }, + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + } + } + }, + "parent": { + "type": "object", + "properties": { + "job": { + "oneOf": [ + { + "type": "string", + "examples": ["fe7043ac41d24206aa556c49"] + }, + { + "type": "object", + "description": "A single job-api object without a parent.job of type object" + } + ] + }, + "task": { + "type": "string", + "examples": ["defc"] + }, + "iteration": { + "type": "number", + "examples": [1] + }, + "element": { + "type": "number", + "examples": [0] + } + } + }, + "errorHandler": { + "oneOf": [ + { + "type": "null" + }, + { + "allOf": [ + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "const": "pending" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "view": { + "type": "string" + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "automatic" + }, + "actor": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "const": "job" + }, + { + "$comment": "Job variable", + "type": "string", + "pattern": "^\\$var\\.job\\.[a-zA-Z_0-9]{1,}$" + }, + { + "$comment": "Task reference", + "type": "string", + "pattern": "^\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" + } + ] + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "const": "operation" + }, + "canvasName": { + "not": { + "const": "childJob" + } + } + } + } + ] + }, + { + "allOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "Stores the x coordinate used by canvasType = 1 workflows" + }, + "y": { + "type": "number", + "description": "Stores the y coordinate used by canvasType = 1 workflows" + }, + "gridCoordinate": { + "type": "object", + "description": "Stores the coordinates used by canvasType = 2 workflows", + "properties": { + "x": { + "type": "number" + }, + "y": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "location": { + "enum": [ + "Adapter", + "Application", + "Broker" + ] + }, + "locationType": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "app": { + "type": "string" + }, + "canvasName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": false, + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "error": { + "type": "string", + "pattern": "" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "deprecated": { + "type": "boolean" + }, + "scheduled": { + "type": "boolean" + }, + "matched": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "highlightString": { + "type": "string" + } + } + } + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "previous": { + "type": "object", + "properties": { + "incomplete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "complete": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + }, + "error": { + "type": "array", + "items": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + } + } + } + }, + "taskId": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "transitions": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "failure": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + }, + "error": { + "type": "array", + "items": { + "type": "object", + "properties": { + "task": { + "oneOf": [ + { + "enum": [ + "workflow_start", + "workflow_end", + "error_handler" + ] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": [ + "workflow_start", + "e28f", + "3a1f" + ] + } + ] + }, + "type": { + "enum": [ + "standard", + "revert", + "loop" + ] + } + } + } + } + } + }, + "serverId": { + "type": "string" + }, + "start_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number" + }, + "finish_state": { + "enum": ["success", "failure", "error"] + }, + "retrySettings": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "properties": { + "state": { + "type": "array", + "items": { + "enum": [ + "success", + "error", + "failure" + ] + } + }, + "autoRetry": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "minimum": 0 + }, + "delay": { + "type": "integer", + "minimum": 0 + }, + "count": { + "type": "integer", + "minimum": 0 + }, + "finishedRetrying": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + } + } + ] + }, + { + "type": "object", + "properties": { + "canvasName": { + "const": "childJob" + }, + "loop": { + "type": "object", + "properties": { + "atLeastOneComplete": { + "type": "boolean" + }, + "finishedCount": { + "type": "number" + }, + "isFinished": { + "type": "object", + "additionalProperties": false, + "patternProperties": { + "^[0-9a-fA-F]{24}$": { + "type": "boolean" + } + } + }, + "outgoing": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "childJobLoopIndex": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "value": { + "type": "integer" + } + } + }, + "_id": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "_id": { + "type": "string" + } + } + }, + "initiator": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "_id": { + "type": "string" + } + } + } + } + }, + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + }, + "childJobs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "iteration": { + "type": "number" + } + } + } + } + } + } + ] + } + ] + }, + { + "type": "object", + "properties": { + "actor": { + "oneOf": [ + { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + { + "const": "job" + } + ] + }, + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "iterations": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "type": "object" + } + ] + } + } + } + } + ] + } + ] + }, + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "const": "default" + } + ] + } + }, + "watchers": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + } + }, + "metrics": { + "allOf": [ + { + "type": "object", + "properties": { + "start_time": { + "type": "number" + }, + "progress": { + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "end_time": { + "type": "number" + } + } + }, + { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + }, + "owner": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + "output": { + "type": "object" + }, + "outputData": { + "type": "object" + } + } + } + ] + }, + "operations-manager_job-common_taskId": { + "oneOf": [ + { + "enum": ["workflow_start", "workflow_end", "error_handler"] + }, + { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["workflow_start", "e28f", "3a1f"] + } + ] + }, + "operations-manager_task-api": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Task Document", + "description": "A Task document in API response format.", + "$comment": "No required fields, because projection operators can result in any combination of fields", + "required": [], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "_id", + "location", + "view", + "status", + "app", + "name", + "variables", + "last_updated", + "encodingVersion", + "job", + "incomingRefs" + ] + }, + { + "enum": ["groups", "type", "metrics", "incomingRefs"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A UUIDv4 identifier.", + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + "location": { + "enum": ["Adapter", "Application", "Broker"] + }, + "view": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["/workflow_engine/task/ViewData"] + } + ] + }, + "status": { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + }, + "app": { + "type": "string", + "examples": ["WorkFlowEngine"] + }, + "name": { + "type": "string", + "examples": ["ViewData", "Stub", "Eval"] + }, + "variables": { + "type": "object", + "properties": { + "incoming": { + "type": "object" + }, + "outgoing": { + "type": "object" + }, + "decorators": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "const": "encryption" + }, + "pointer": { + "type": "string", + "format": "json-pointer" + } + } + } + } + } + }, + "last_updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "encodingVersion": { + "enum": [1] + }, + "job": { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "task": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["e28f", "3a1f", "b4f"] + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["View Task Data"] + } + ] + }, + "ancestors": { + "oneOf": [ + { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "type": "null" + } + ] + } + } + }, + "incomingRefs": { + "type": "array" + } + } + }, + { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "name": { + "type": "string", + "examples": ["admin"] + }, + "description": { + "type": "string" + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": ["66ec91e12b18975149d9e0d9"] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "metrics": { + "allOf": [ + { + "type": "object", + "properties": { + "start_time": { + "type": "string", + "example": ["2025-03-11T19:03:31.515Z"] + }, + "claim_time": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end_time": { + "type": "number", + "examples": [1740438512495] + }, + "server_id": { + "type": "string", + "examples": [ + "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" + ] + }, + "finish_state": { + "oneOf": [ + { + "const": "success" + }, + { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + } + ] + }, + "run_time": { + "type": "number", + "examples": [5] + } + } + }, + { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + }, + "owner": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + } + } + } + ] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "operation" + }, + "metrics": { + "allOf": [ + { + "type": "object", + "properties": { + "start_time": { + "type": "string", + "example": ["2024-03-11T19:03:31.515Z"] + }, + "end_time": { + "type": "number", + "example": [1740438512495] + }, + "server_id": { + "type": "string", + "examples": [ + "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" + ] + }, + "finish_state": { + "oneOf": [ + { + "const": "success" + }, + { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + } + ] + }, + "run_time": { + "type": "number", + "examples": [6] + }, + "retrying": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + }, + "owner": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + } + } + } + ] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "automatic" + }, + "metrics": { + "allOf": [ + { + "type": "object", + "properties": { + "start_time": { + "type": "string", + "example": ["2024-03-11T19:03:31.515Z"] + }, + "end_time": { + "type": "number", + "example": [1740438512495] + }, + "server_id": { + "type": "string", + "examples": [ + "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" + ] + }, + "finish_state": { + "oneOf": [ + { + "const": "success" + }, + { + "enum": [ + "incomplete", + "scheduled", + "running", + "complete", + "canceled", + "error", + "failure", + "paused" + ] + } + ] + }, + "run_time": { + "type": "number", + "examples": [6] + }, + "retrying": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "user": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + }, + "owner": { + "oneOf": [ + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "provenance": { + "type": "string", + "examples": ["Local AAA"] + }, + "username": { + "type": "string", + "examples": ["admin@pronghorn"] + }, + "firstname": { + "type": "string", + "examples": ["admin"] + }, + "memberOf": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "aaaManaged": { + "type": "boolean" + } + } + } + }, + "assignedRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "examples": [ + "66ec91e12b18975149d9e0d9" + ] + } + } + } + }, + "inactive": { + "type": "boolean" + }, + "lastLogin": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "_meta": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "updated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "email": { + "type": "string", + "examples": ["admin@itential.com"] + } + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "enum": ["", "Pronghorn"] + } + ] + } + } + } + ] + } + } + } + ] + } + ] + }, + "operations-manager_task-common_taskId": { + "type": "string", + "pattern": "^[0-9a-f]{1,4}$", + "examples": ["e28f", "3a1f", "b4f"] + }, + "operations-manager_trigger-api": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger", + "description": "An Endpoint Trigger in API response format.", + "required": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "lastExecuted", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "verb", + "routeName", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger", + "description": "An EventSystem Trigger in API response format.", + "required": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "lastExecuted", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "source", + "topic", + "schema", + "legacyWrapper", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["source", "topic", "schema", "legacyWrapper"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger", + "description": "A Manual Trigger in API response format.", + "required": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "lastExecuted", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "formData", + "legacyWrapper", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["formData", "formSchemaHash", "legacyWrapper"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Trigger", + "description": "A Schedule Trigger in API response format.", + "required": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "lastExecuted", + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated", + "formData", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "processMissedRuns", + "locked", + "repeatUnit", + "repeatFrequency", + "repeatInterval", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": ["repeating", "terminating"] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + }, + "operations-manager_trigger-common_commonFields": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + "operations-manager_trigger-create": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger Create", + "description": "The format of accepted input for the creation of an Endpoint Trigger.", + "required": ["name", "type", "routeName"], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger Create", + "description": "The format of accepted input for the creation of an EventSystem Trigger.", + "required": ["name", "type", "topic"], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["source", "topic", "schema", "legacyWrapper"] + }, + { + "enum": ["jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger Create", + "description": "The format of accepted input for the creation of a Manual Trigger.", + "required": ["name", "type"], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["formData", "formSchemaHash", "legacyWrapper"] + }, + { + "enum": ["formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Trigger Create", + "description": "The format of accepted input for the creation of a Schedule Trigger.", + "required": ["name", "type", "processMissedRuns"], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["formId"] + } + ] + }, + "oneOf": [ + { + "required": ["repeatUnit", "repeatFrequency"] + }, + { + "not": { + "required": ["repeatUnit", "repeatFrequency"] + } + } + ], + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "const": "Pronghorn" + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": ["repeating", "terminating"] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + }, + "operations-manager_trigger-json": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger", + "description": "An Endpoint Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "verb", + "routeName", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger", + "description": "An EventSystem Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "source", + "topic", + "schema", + "_id", + "jst" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["source", "topic", "schema", "legacyWrapper"] + }, + { + "enum": ["_id", "jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "jst": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger", + "description": "A Manual Trigger in JSON/export format.", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "formData", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["formData", "formSchemaHash", "legacyWrapper"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Triggers Schema for JSON Representation", + "description": "Schema for a Schedule Trigger JSON representation", + "required": [ + "name", + "type", + "enabled", + "actionType", + "actionId", + "formData", + "firstRunAt", + "processMissedRuns", + "repeatUnit", + "repeatFrequency", + "repeatInterval", + "_id", + "formId" + ], + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["_id", "formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "string", + "examples": ["admin@pronghorn"] + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": ["repeating", "terminating"] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "formId": { + "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + }, + "operations-manager_trigger-update": { + "$schema": "http://json-schema.org/draft-07/schema", + "oneOf": [ + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Endpoint Trigger Updates", + "description": "The format of accepted input for an update operation on an Endpoint Trigger.", + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": ["verb", "routeName", "schema"] + }, + { + "enum": ["jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "endpoint" + }, + "verb": { + "const": "POST" + }, + "routeName": { + "description": "User defined route name.", + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "examples": [ + "runSoftwareUpgrade", + "runInfoBloxCreateARecord" + ] + }, + "schema": { + "description": "POST body filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + { + "type": "object", + "properties": { + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "EventSystem Trigger Updates", + "description": "The format of accepted input for an update operation on an EventSystem Trigger.", + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": ["source", "topic", "schema", "legacyWrapper"] + }, + { + "enum": ["jst"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "eventSystem" + }, + "source": { + "description": "The source of the event.", + "type": "string", + "examples": ["@itential/app-operations_manager"] + }, + "topic": { + "description": "The event topic.", + "type": "string", + "examples": ["missedJobs"] + }, + "schema": { + "description": "Event payload filter schema.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether payload data is wrapped in a 'payload' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "jst": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Manual Trigger Updates", + "description": "The format of accepted input for an update operation on a Manual Trigger.", + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": ["formData", "formSchemaHash", "legacyWrapper"] + }, + { + "enum": ["formId"] + } + ] + }, + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "manual" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + } + } + }, + { + "type": "object", + "properties": { + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Schedule Trigger Updates", + "description": "The format of accepted input for an update operation on a Schedule Trigger.", + "propertyNames": { + "anyOf": [ + { + "enum": [ + "name", + "description", + "type", + "enabled", + "actionType", + "actionId", + "options", + "lastExecuted", + "migrationVersion" + ] + }, + { + "enum": [ + "formData", + "formSchemaHash", + "legacyWrapper", + "firstRunAt", + "nextRunAt", + "stopRunningAt", + "lastIntervalStart", + "processMissedRuns", + "locked", + "waitFlag", + "repeat" + ] + }, + { + "enum": ["repeatUnit", "repeatFrequency"] + }, + { + "enum": ["repeatInterval"] + }, + { + "enum": ["formId"] + } + ] + }, + "oneOf": [ + { + "required": ["repeatUnit", "repeatFrequency"] + }, + { + "not": { + "required": ["repeatUnit", "repeatFrequency"] + } + } + ], + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": [ + "Cisco IOS upgrade", + "Port Turn UP - IOS - IAG", + "Consume Message Kafka-V2" + ], + "not": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": [ + "Turn up the port", + "Consume message from Topic", + "Run software upgrade on Cisco routers running IOS XR software" + ] + }, + "enabled": { + "type": "boolean", + "description": "A flag to determine if this Trigger is enabled or not." + }, + "actionType": { + "type": "string", + "description": "The type of component this Trigger will invoke.", + "enum": ["automations"] + }, + "actionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "options": { + "type": "object", + "description": "Configuration options specific to this trigger.", + "properties": { + "targetType": { + "oneOf": [ + { + "enum": ["instance", "group"] + }, + { + "type": "null" + } + ] + }, + "targetIdentifier": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + }, + "chooseTargetAtRuntime": { + "type": "boolean" + }, + "actionId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + }, + "lastExecuted": { + "description": "A timestamp in milliseconds of the time this Trigger was last executed.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "migrationVersion": { + "description": "The current document version of this document.", + "type": "integer", + "examples": [1, 2, 3] + } + } + }, + { + "type": "object", + "properties": { + "type": { + "const": "schedule" + }, + "formData": { + "description": "A JSON object created by filling out the associated JSON Form.", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "examples": [ + { + "deviceName": "ATL-123", + "action": "SYNC" + }, + { + "ip": "1.2.3.4", + "name": "Cisco IOS XR" + } + ] + }, + "formSchemaHash": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "legacyWrapper": { + "description": "A boolean determining whether form data is wrapped in a 'formData' property", + "type": "boolean" + }, + "firstRunAt": { + "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", + "type": "integer", + "minimum": 0 + }, + "nextRunAt": { + "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "example": 1648829216268 + }, + "stopRunningAt": { + "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "lastIntervalStart": { + "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + }, + "processMissedRuns": { + "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", + "type": "string", + "enum": ["none", "last"] + }, + "locked": { + "description": "backend use only", + "type": "boolean" + }, + "waitFlag": { + "description": "Deprecated, backend use only", + "type": "boolean" + }, + "repeat": { + "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", + "oneOf": [ + { + "type": "null" + }, + { + "oneOf": [ + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "enum": ["repeating", "terminating"] + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "date-range" + }, + "start": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "end": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "type": { + "const": "count" + }, + "duration": { + "oneOf": [ + { + "type": "object", + "properties": { + "unit": { + "const": "second" + }, + "quantity": { + "type": "number", + "minimum": 0, + "multipleOf": 10, + "examples": [30, 140, 2000] + } + } + }, + { + "type": "object", + "properties": { + "unit": { + "enum": [ + "minute", + "hour", + "day", + "week" + ] + }, + "quantity": { + "type": "number", + "minimum": 0, + "examples": [1, 3, 5, 10] + } + } + }, + { + "$comment": "Implicit unit of milliseconds", + "type": "number", + "minimum": 0, + "multipleOf": 10000, + "examples": [10000, 30000, 100000] + } + ] + }, + "count": { + "type": "integer", + "minimum": 0, + "examples": [2, 5, 10, 25] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "enum": ["execute", "wait"] + } + }, + "required": ["action"] + }, + { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": {} + } + }, + "required": ["components"] + } + ] + } + ] + } + ] + } + ] + } + } + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "null" + }, + "repeatFrequency": { + "type": "null" + } + } + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "type": "string", + "enum": ["minute", "hour", "day", "week"] + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit"] + }, + { + "type": "object", + "properties": { + "repeatUnit": { + "const": "second" + }, + "repeatFrequency": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "multipleOf": 10 + }, + { + "type": "null" + } + ] + } + }, + "required": ["repeatUnit", "repeatFrequency"] + } + ] + }, + { + "type": "object", + "properties": { + "repeatInterval": { + "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "examples": [10000, 30000, 120000] + } + } + }, + { + "type": "object", + "properties": { + "formId": { + "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "null" + } + ] + } + } + } + ] + } + ] + }, + "mop_mopAnalyticTemplateDoc": { + "title": "mop analytic template", + "description": "A mop analytic template object", + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + "os": { + "type": "string", + "examples": ["cisco-ios"] + }, + "passRule": { + "type": "boolean" + }, + "prepostCommands": { + "type": "array", + "items": { + "type": "object", + "properties": { + "preRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "postRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "passRule": { + "type": "boolean" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["regex"] + }, + "preRegex": { + "type": "string", + "examples": [""] + }, + "postRegex": { + "type": "string", + "examples": [""] + }, + "evaluation": { + "type": "string", + "examples": ["="] + } + } + } + }, + "preCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + }, + "postCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + } + } + } + }, + "created": { + "type": "integer", + "examples": [1508182880981] + }, + "createdBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + }, + "lastUpdated": { + "type": "integer", + "examples": [1508182880981] + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + } + }, + "required": ["name"] + }, + "mop_mopAnalyticTemplateDoc__id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "mop_mopAnalyticTemplateDoc_name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "mop_mopAnalyticTemplateDoc_successResponse": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "n": { + "type": "integer", + "examples": [1] + }, + "ok": { + "type": "integer", + "examples": [1] + } + } + }, + "ops": { + "type": "array", + "items": { + "title": "mop analytic template", + "description": "A mop analytic template object", + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + "os": { + "type": "string", + "examples": ["cisco-ios"] + }, + "passRule": { + "type": "boolean" + }, + "prepostCommands": { + "type": "array", + "items": { + "type": "object", + "properties": { + "preRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "postRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "passRule": { + "type": "boolean" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["regex"] + }, + "preRegex": { + "type": "string", + "examples": [""] + }, + "postRegex": { + "type": "string", + "examples": [""] + }, + "evaluation": { + "type": "string", + "examples": ["="] + } + } + } + }, + "preCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + }, + "postCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + } + } + } + }, + "created": { + "type": "integer", + "examples": [1508182880981] + }, + "createdBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + }, + "lastUpdated": { + "type": "integer", + "examples": [1508182880981] + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + } + }, + "required": ["name"], + "definitions": { + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "projectNamespace": { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "_id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "prepostCommand": { + "type": "object", + "properties": { + "preRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "postRawCommand": { + "type": "string", + "examples": ["show running-config ip prefix-list"] + }, + "passRule": { + "type": "boolean" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "examples": ["regex"] + }, + "preRegex": { + "type": "string", + "examples": [""] + }, + "postRegex": { + "type": "string", + "examples": [""] + }, + "evaluation": { + "type": "string", + "examples": ["="] + } + } + } + }, + "preCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + }, + "postCommandResHTML": { + "type": "string", + "examples": [ + "Test a command or the template to get results here" + ] + } + } + }, + "successResponse": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "n": { + "type": "integer", + "examples": [1] + }, + "ok": { + "type": "integer", + "examples": [1] + } + } + }, + "ops": { + "type": "array", + "items": {} + }, + "insertedCount": { + "type": "integer", + "examples": [1] + }, + "insertedIds": { + "type": "object", + "properties": { + "0": { + "type": "string", + "examples": ["TestAnalysisTemp"] + } + } + } + } + } + } + } + }, + "insertedCount": { + "type": "integer", + "examples": [1] + }, + "insertedIds": { + "type": "object", + "properties": { + "0": { + "type": "string", + "examples": ["TestAnalysisTemp"] + } + } + } + } + }, + "mop_mopTemplateDoc": { + "title": "mop template", + "description": "A mop template object", + "type": "object", + "properties": { + "_id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "namespace": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "object", + "required": [], + "properties": { + "type": { + "const": "project" + }, + "_id": { + "type": "string", + "examples": ["5cb5252a1bbc5a00def564c1"] + }, + "name": { + "type": "string" + }, + "accessControl": { + "type": "object", + "properties": { + "read": { + "type": "array", + "items": { + "type": "string" + } + }, + "execute": { + "type": "array", + "items": { + "type": "string" + } + }, + "write": { + "type": "array", + "items": { + "type": "string" + } + }, + "manage": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + "os": { + "type": "string", + "examples": ["cisco-ios"] + }, + "passRule": { + "type": "boolean" + }, + "commands": { + "type": "array", + "items": { + "type": "object", + "properties": { + "command": { + "type": "string", + "examples": ["show running-config ip vrf"] + }, + "passRule": { + "type": "boolean" + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "type": "string", + "examples": ["show version"] + }, + "eval": { + "type": "string", + "examples": ["contains"] + }, + "raw": { + "type": "string", + "examples": ["show version"] + }, + "result": { + "type": "boolean" + } + }, + "required": ["rule", "eval"] + } + } + } + } + }, + "created": { + "type": "integer", + "examples": [1508182880981] + }, + "createdBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + }, + "lastUpdated": { + "type": "integer", + "examples": [1508182880981] + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "string", + "examples": ["exampleUser"] + } + ] + } + }, + "required": ["name"] + }, + "mop_mopTemplateDoc__id": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "mop_mopTemplateDoc_name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "mop_mopTemplateDoc_successResponse": { + "type": "object", + "properties": { + "n": { + "type": "integer", + "examples": [1] + }, + "ok": { + "type": "integer", + "examples": [1] + }, + "nModified": { + "type": "integer", + "examples": [1] + } + } + }, + "mop_mopTemplateDoc_variables": { + "type": "object", + "properties": {}, + "examples": [ + { + "device_name": "my-device1" + } + ] + }, + "mop_mopTemplateDoc_devices": { + "type": "array", + "items": { + "type": "string", + "examples": ["Device 2", "Device 1"] + } + }, + "mop_mopTemplateDoc_runCommandRes": { + "type": "object", + "properties": { + "raw": { + "type": "string", + "examples": ["show version"] + }, + "all_pass_flag": { + "type": "boolean" + }, + "evaluated": { + "type": "string", + "examples": ["show version"] + }, + "parameters": { + "type": "object", + "properties": {} + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "type": "string", + "examples": ["show version"] + }, + "eval": { + "type": "string", + "examples": ["contains"] + }, + "raw": { + "type": "string", + "examples": ["show version"] + }, + "result": { + "type": "boolean" + } + }, + "required": ["rule", "eval"] + } + }, + "device": { + "type": "string", + "examples": ["device1"] + }, + "response": { + "type": "string", + "examples": ["version: 10.0.0"] + }, + "result": { + "type": "boolean" + } + } + }, + "mop_mopTemplateDoc_device": { + "type": "string", + "examples": ["device1"] + }, + "mop_mopTemplateDoc_options": { + "type": "object", + "properties": { + "start": { + "type": "integer", + "examples": [0] + }, + "limit": { + "type": "integer", + "examples": [25] + }, + "entity": { + "type": "string", + "examples": ["device1"] + }, + "filter": { + "type": "string", + "examples": ["filter"] + }, + "sort": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "integer", + "examples": [1] + } + } + } + } + } + }, + "mop_mopTemplateDoc_detailedDevice": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": ["ASR1K-MOP"] + }, + "authgroup": { + "type": "string", + "examples": ["csr-aws", "default"] + }, + "address": { + "type": "string", + "examples": ["127.0.0.1"] + }, + "port": { + "type": "string", + "examples": ["12035"] + }, + "device-type": { + "type": "string", + "examples": ["netconf"] + }, + "ned": { + "type": "string", + "examples": ["nso46"] + }, + "admin": { + "type": "boolean" + }, + "host": { + "type": "string", + "examples": ["Local Host"] + }, + "groups": { + "type": "array", + "items": { + "type": "string", + "examples": ["Group1"] + } + } + } + }, + "lifecycle-manager_common-http_document-identifier": { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + }, + "lifecycle-manager_common-http_pagination-metadata": { + "description": "Properties describing search result pagination", + "type": "object", + "properties": { + "skip": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "nextPageSkip": { + "type": "integer" + }, + "previousPageSkip": { + "type": "integer" + }, + "currentPageSize": { + "type": "integer" + } + } + }, + "lifecycle-manager_common-http_response": { + "oneOf": [ + { + "description": "A success response from an API method", + "type": "object", + "additionalProperties": false, + "required": ["message", "data", "metadata"], + "properties": { + "message": { + "description": "A human-readable message summarizing the result of the operation", + "type": "string", + "examples": [ + "Successfully created the requested item", + "Successfully imported 3 of 4 documents", + "Successfully retrieved search results" + ] + }, + "data": { + "const": "null", + "description": "Any successfully retrieved information related to the request." + }, + "metadata": { + "description": "Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.", + "type": "object", + "additionalProperties": true + } + } + }, + { + "description": "A failure response from an API method", + "type": "object", + "additionalProperties": false, + "required": ["message", "data", "metadata"], + "properties": { + "message": { + "description": "A human-readable message summarizing the result of the operation", + "type": "string", + "examples": [ + "A server error occurred while processing this request" + ] + }, + "data": { + "const": "null", + "description": "Any successfully retrieved information related to the request. For error responses, this is always 'null'." + }, + "metadata": { + "description": "Any structured, wordy or machine-readable information related to the result of the operation. For error responses, this will always at least contain an 'errors' array, even if it is empty.", + "type": "object", + "properties": { + "errors": { + "type": "array" + } + }, + "additionalProperties": true + } + } + } + ] + }, + "lifecycle-manager_common_name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "lifecycle-manager_common_ObjectIdLikeString": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "lifecycle-manager_common_ObjectId": { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + }, + "lifecycle-manager_instance-group-create": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Resource Instance Group Create", + "description": "The format of accepted input for the creation of a Resource Instance Group document.", + "type": "object", + "allOf": [ + { + "propertyNames": { + "enum": [ + "name", + "description", + "modelId", + "type", + "lastAction", + "instances", + "filter" + ] + } + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": ["Some helpful information about the document"] + }, + "modelId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "oneOf": [ + { + "type": "object", + "not": { + "required": ["filter"] + }, + "properties": { + "type": { + "const": "manual" + }, + "instances": { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "type": "object", + "not": { + "required": ["instances"] + }, + "properties": { + "type": { + "const": "dynamic" + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "lastAction": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + }, + "created": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "updated": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + } + } + } + } + } + ] + } + ] + }, + { + "required": ["name", "modelId"] + } + ] + }, + "lifecycle-manager_instance-group-http": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Resource Instance Group Document", + "description": "A Resource Instance Group document in HTTP response format.", + "type": "object", + "allOf": [ + { + "propertyNames": { + "anyOf": [ + { + "enum": [ + "createdBy", + "created", + "lastUpdatedBy", + "lastUpdated" + ] + }, + { + "enum": ["_id"] + }, + { + "enum": [ + "name", + "description", + "modelId", + "type", + "lastAction", + "instances", + "filter" + ] + } + ] + } + }, + { + "type": "object", + "required": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] + }, + { + "type": "object", + "properties": { + "createdBy": { + "oneOf": [ + { + "type": "object", + "properties": { + "firstname": { + "type": "string" + }, + "provenance": { + "type": "string" + }, + "username": { + "type": "string" + }, + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "type": "null" + } + ] + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "oneOf": [ + { + "type": "object", + "properties": { + "firstname": { + "type": "string" + }, + "provenance": { + "type": "string" + }, + "username": { + "type": "string" + }, + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "type": "null" + } + ] + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + { + "type": "object", + "required": ["_id"] + }, + { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "allOf": [ + { + "type": "object", + "required": [ + "name", + "description", + "modelId", + "type", + "lastAction" + ] + }, + { + "oneOf": [ + { + "type": "object", + "required": ["instances"] + }, + { + "type": "object", + "required": ["filter"] + } + ] + } + ] + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": ["Some helpful information about the document"] + }, + "modelId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "oneOf": [ + { + "type": "object", + "not": { + "required": ["filter"] + }, + "properties": { + "type": { + "const": "manual" + }, + "instances": { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "type": "object", + "not": { + "required": ["instances"] + }, + "properties": { + "type": { + "const": "dynamic" + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "lastAction": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + }, + "created": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "updated": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + } + } + } + } + } + ] + } + ] + }, + { + "type": "object", + "properties": { + "lastAction": { + "description": "The last action that was run against this document", + "type": "object", + "additionalProperties": false, + "required": ["_id", "executionId", "name", "type", "status"], + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "executionId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": [ + "running", + "error", + "complete", + "canceled", + "paused" + ] + } + } + } + } + } + ] + }, + "lifecycle-manager_instance-group-search-params": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Resource Instance Group Search Parameters", + "description": "Search Parameters supported on the Resource Instance Group collection.", + "type": "object", + "allOf": [ + { + "type": "object", + "properties": { + "skip": { + "description": "This parameter specifies where to start the returned page of search results.", + "type": "string" + }, + "limit": { + "description": "This parameter specifies how many items to return in the search results.", + "type": "string" + } + } + }, + { + "type": "object", + "properties": { + "sort": { + "description": "This parameter specifies the field to sort the search results over.", + "type": "string", + "examples": ["name", "created"] + }, + "order": { + "description": "This parameter specifies the direction to sort the search results over.", + "enum": ["asc", "desc"] + } + } + }, + { + "properties": { + "equals": { + "type": "object", + "properties": { + "modelName": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "type": { + "enum": ["manual", "dynamic"] + }, + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "modelId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "createdBy": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdatedBy": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + "in": { + "allOf": [ + { + "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", + "type": "object", + "examples": [ + { + "stateId": "1234,53fe,0000" + }, + { + "name": "name1,name2,name3" + } + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "array", + "items": { + "enum": ["manual", "dynamic"] + } + }, + "lastAction": { + "type": "object", + "properties": { + "type": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + } + } + } + } + } + ] + }, + "starts-with": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + } + } + }, + "lt": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "lte": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "gt": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "gte": { + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "dereference": { + "description": "Comma-separated list of foreign key field types to dereference", + "const": "accounts" + } + } + } + ] + }, + "lifecycle-manager_instance-group-update": { + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Resource Instance Group Update", + "description": "The format of accepted input for updating a Resource Instance Group document.", + "type": "object", + "allOf": [ + { + "propertyNames": { + "allOf": [ + { + "enum": [ + "name", + "description", + "modelId", + "type", + "lastAction", + "instances", + "filter" + ] + }, + { + "enum": ["instancesToAdd", "instancesToRemove"] + } + ] + } + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "description": { + "type": "string", + "description": "The description of the document", + "examples": ["Some helpful information about the document"] + }, + "modelId": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + }, + { + "oneOf": [ + { + "type": "object", + "not": { + "required": ["filter"] + }, + "properties": { + "type": { + "const": "manual" + }, + "instances": { + "type": "array", + "items": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + } + } + }, + { + "type": "object", + "not": { + "required": ["instances"] + }, + "properties": { + "type": { + "const": "dynamic" + }, + "filter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "lastAction": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + }, + "created": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + }, + "updated": { + "type": "object", + "properties": { + "before": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "after": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + } + } + } + } + } + } + } + ] + } + ] + }, + { + "properties": { + "instancesToAdd": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + } + ] + } + }, + "instancesToRemove": { + "type": "array", + "items": { + "oneOf": [ + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + } + ] + } + } + } + } + ] + }, + "lifecycle-manager_resource-action-execution-http": { + "oneOf": [ + { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "modelId", + "modelName", + "instanceId", + "instanceName", + "actionId", + "actionName", + "jobId", + "startTime", + "endTime", + "progress", + "status", + "errors", + "initiator", + "initiatorName", + "initialInstanceData", + "finalInstanceData" + ], + "properties": { + "_id": {}, + "modelId": {}, + "modelName": { + "description": "The name of the model as it was when the action was run", + "type": "string" + }, + "executionType": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + }, + "instanceId": {}, + "instanceName": { + "description": "The name of the instance as it was when the action was run", + "type": "string" + }, + "actionId": { + "description": "Identifier of the action that was run" + }, + "actionName": { + "description": "The name of the action as it was when the action was run", + "type": "string" + }, + "actionType": { + "description": "The type of the action" + }, + "jobId": { + "description": "Identifier of the job associated with the action", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "progress": { + "description": "A sequence of key points in the action describing its overall progress", + "type": "object", + "patternProperties": { + ".*": { + "description": "A record indicating a progress point in the flow of the action", + "type": "object", + "additionalProperties": false, + "required": [ + "progressType", + "status", + "error", + "_id", + "componentName", + "componentId" + ], + "properties": { + "_id": { + "description": "Uniquely identifies the progress point within the overall sequence", + "type": "string" + }, + "componentId": { + "description": "The id of the component related to the step", + "type": "string" + }, + "componentName": { + "description": "The name of the component related to the step", + "type": "string" + }, + "progressType": { + "description": "Designates what type of progress point this object describes", + "const": "resource:action" + }, + "error": { + "description": "Records any errors directly related to the components in the progress item", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "status": { + "description": "Designates the status of the progress item", + "type": "string", + "enum": ["pending", "complete", "error"] + } + } + } + } + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": ["running", "error", "complete", "canceled", "paused"] + }, + "errors": { + "description": "A list of any errors which occurred while the action was running", + "type": "array", + "items": { + "description": "A record of an error which occurred while the action was running", + "type": "object", + "properties": { + "message": { + "description": "A human-readable message summarizing the issue", + "type": "string" + }, + "origin": { + "description": "Designates where the error came from", + "type": "string", + "enum": [ + "preTransformation", + "workflow", + "postTransformation", + "finishAction", + "system" + ] + }, + "timestamp": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "metadata": { + "description": "Additional properties that help describe the issue" + }, + "stepId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + } + }, + "initiator": {}, + "initiatorName": { + "description": "The name of the user or automation trigger that initiated the action", + "type": "string" + }, + "initialInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + }, + "finalInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + } + } + }, + { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "modelId", + "modelName", + "instanceId", + "instanceName", + "actionId", + "actionName", + "parentActionExecutionId", + "jobId", + "startTime", + "endTime", + "progress", + "status", + "errors", + "initiator", + "initiatorName", + "initialInstanceData", + "finalInstanceData" + ], + "properties": { + "_id": {}, + "modelId": {}, + "modelName": { + "description": "The name of the model as it was when the action was run", + "type": "string" + }, + "executionType": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + }, + "instanceId": {}, + "instanceName": { + "description": "The name of the instance as it was when the action was run", + "type": "string" + }, + "actionId": { + "description": "Identifier of the action that was run" + }, + "actionName": { + "description": "The name of the action as it was when the action was run", + "type": "string" + }, + "actionType": { + "description": "The type of the action" + }, + "parentActionExecutionId": { + "description": "Identifier of the job associated with the action" + }, + "groupId": { + "description": "Identifier of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "groupName": { + "description": "The name of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "jobId": { + "description": "Identifier of the job associated with the action", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "progress": { + "description": "A sequence of key points in the action describing its overall progress", + "type": "object", + "patternProperties": { + ".*": { + "description": "A record indicating a progress point in the flow of the action", + "type": "object", + "additionalProperties": false, + "required": [ + "progressType", + "status", + "error", + "_id", + "componentName", + "componentId" + ], + "properties": { + "_id": { + "description": "Uniquely identifies the progress point within the overall sequence", + "type": "string" + }, + "componentId": { + "description": "The id of the component related to the step", + "type": "string" + }, + "componentName": { + "description": "The name of the component related to the step", + "type": "string" + }, + "progressType": { + "description": "Designates what type of progress point this object describes", + "const": "resource:action" + }, + "error": { + "description": "Records any errors directly related to the components in the progress item", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "status": { + "description": "Designates the status of the progress item", + "type": "string", + "enum": ["pending", "complete", "error"] + } + } + } + } + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": ["running", "error", "complete", "canceled", "paused"] + }, + "errors": { + "description": "A list of any errors which occurred while the action was running", + "type": "array", + "items": { + "description": "A record of an error which occurred while the action was running", + "type": "object", + "properties": { + "message": { + "description": "A human-readable message summarizing the issue", + "type": "string" + }, + "origin": { + "description": "Designates where the error came from", + "type": "string", + "enum": [ + "preTransformation", + "workflow", + "postTransformation", + "finishAction", + "system" + ] + }, + "timestamp": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "metadata": { + "description": "Additional properties that help describe the issue" + }, + "stepId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + } + }, + "initiator": {}, + "initiatorName": { + "description": "The name of the user or automation trigger that initiated the action", + "type": "string" + }, + "initialInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + }, + "finalInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + } + } + }, + { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "modelId", + "modelName", + "instanceIds", + "childStatuses", + "actionId", + "actionName", + "jobId", + "startTime", + "endTime", + "progress", + "status", + "errors", + "initiator", + "initiatorName" + ], + "properties": { + "_id": {}, + "modelId": {}, + "modelName": { + "description": "The name of the model as it was when the action was run", + "type": "string" + }, + "executionType": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + }, + "instanceIds": { + "description": "The IDs of the instances that are being acted upon", + "type": "array", + "items": {} + }, + "childStatuses": { + "description": "An object mapping the current status of child action executions", + "type": "object" + }, + "actionId": { + "description": "Identifier of the action that was run" + }, + "actionName": { + "description": "The name of the action as it was when the action was run", + "type": "string" + }, + "actionType": { + "description": "The type of the action" + }, + "groupId": { + "description": "Identifier of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "groupName": { + "description": "The name of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "jobId": { + "description": "Identifier of the job associated with the action", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "progress": { + "description": "A sequence of key points in the action describing its overall progress", + "type": "object", + "patternProperties": { + ".*": { + "description": "A record indicating a progress point in the flow of the action", + "type": "object", + "additionalProperties": false, + "required": [ + "progressType", + "status", + "error", + "_id", + "componentName", + "componentId" + ], + "properties": { + "_id": { + "description": "Uniquely identifies the progress point within the overall sequence", + "type": "string" + }, + "componentId": { + "description": "The id of the component related to the step", + "type": "string" + }, + "componentName": { + "description": "The name of the component related to the step", + "type": "string" + }, + "progressType": { + "description": "Designates what type of progress point this object describes", + "const": "resource:action" + }, + "error": { + "description": "Records any errors directly related to the components in the progress item", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "status": { + "description": "Designates the status of the progress item", + "type": "string", + "enum": ["pending", "complete", "error"] + } + } + } + } + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": ["running", "error", "complete", "canceled", "paused"] + }, + "errors": { + "description": "A list of any errors which occurred while the action was running", + "type": "array", + "items": { + "description": "A record of an error which occurred while the action was running", + "type": "object", + "properties": { + "message": { + "description": "A human-readable message summarizing the issue", + "type": "string" + }, + "origin": { + "description": "Designates where the error came from", + "type": "string", + "enum": [ + "preTransformation", + "workflow", + "postTransformation", + "finishAction", + "system" + ] + }, + "timestamp": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "metadata": { + "description": "Additional properties that help describe the issue" + }, + "stepId": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + } + } + } + }, + "initiator": { + "oneOf": [ + { + "const": "Pronghorn" + }, + {} + ] + }, + "initiatorName": { + "type": "string" + }, + "initialInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + }, + "finalInstanceData": { + "anyOf": [ + { + "type": "null" + }, + { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + ] + } + } + } + ] + }, + "lifecycle-manager_resource-action-execution-search-params": { + "description": "Search parameters for resource action executions", + "type": "object", + "additionalProperties": false, + "required": [], + "allOf": [ + { + "type": "object", + "properties": { + "skip": { + "description": "This parameter specifies where to start the returned page of search results.", + "type": "string" + }, + "limit": { + "description": "This parameter specifies how many items to return in the search results.", + "type": "string" + } + } + }, + { + "type": "object", + "properties": { + "sort": { + "description": "This parameter specifies the field to sort the search results over.", + "type": "string", + "examples": ["name", "created"] + }, + "order": { + "description": "This parameter specifies the direction to sort the search results over.", + "enum": ["asc", "desc"] + } + } + }, + { + "type": "object", + "properties": { + "equals": { + "type": "object", + "properties": { + "_id": {}, + "modelId": {}, + "modelName": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "instanceId": {}, + "instanceName": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "groupId": {}, + "groupName": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + "actionId": { + "description": "The identifier of an action" + }, + "actionName": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "jobId": {}, + "executionType": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + }, + "startTime": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "endTime": { + "type": "string", + "description": "An ISO 8601 date string", + "format": "date-time" + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": [ + "running", + "error", + "complete", + "canceled", + "paused" + ] + }, + "initiator": {}, + "parentActionExecutionId": {} + } + }, + "in": { + "allOf": [ + { + "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", + "type": "object", + "examples": [ + { + "stateId": "1234,53fe,0000" + }, + { + "name": "name1,name2,name3" + } + ] + }, + { + "type": "object", + "properties": { + "modelId": { + "description": "A comma-delineated list of model ids to search for", + "type": "array", + "items": {} + }, + "gruopId": { + "description": "A comma-delineated list of group ids to search for", + "type": "array", + "items": {} + }, + "status": { + "description": "A comma-delineated list of statuses to search for", + "type": "array", + "items": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": [ + "running", + "error", + "complete", + "canceled", + "paused" + ] + } + }, + "executionType": { + "description": "A comma-delineated list of execution types to search for", + "type": "array", + "items": { + "description": "The type of execution action", + "type": "string", + "enum": ["individual", "parent", "child"] + } + } + } + } + ] + }, + "starts-with": { + "type": "object", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "groupName": { + "description": "The name of the group the bulk action was run against", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "instanceName": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "actionName": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "initiatorName": { + "type": "string" + } + } + }, + "lt": { + "type": "object", + "properties": { + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + } + } + }, + "lte": { + "type": "object", + "properties": { + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + } + } + }, + "gt": { + "type": "object", + "properties": { + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + } + } + }, + "gte": { + "type": "object", + "properties": { + "startTime": { + "description": "The time at which the action was started", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time at which the action ended", + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + } + } + }, + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ] + }, + "lifecycle-manager_resource-instance-common_name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "lifecycle-manager_resource-instance-common_description": { + "type": "string", + "description": "Free-form text describing the resource instance", + "default": "", + "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] + }, + "lifecycle-manager_resource-instance-export": { + "type": "object", + "additionalProperties": false, + "required": [ + "name", + "description", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy", + "instanceData" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource instance", + "default": "", + "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] + }, + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource instance" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource instance" + }, + "instanceData": { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + } + }, + "lifecycle-manager_resource-instance-http": { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "name", + "description", + "modelId", + "instanceData", + "lastAction", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource instance", + "default": "", + "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] + }, + "modelId": {}, + "instanceData": { + "description": "The data for the resource instance", + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "lastAction": { + "description": "The last action that was run on this instance", + "type": "object", + "additionalProperties": false, + "required": ["_id", "executionId", "name", "type", "status"], + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "executionId": {}, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "status": { + "description": "A single string describing the current activity status of this action", + "type": "string", + "enum": ["running", "error", "complete", "canceled", "paused"] + } + } + }, + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource instance" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource instance" + }, + "instanceGroups": { + "description": "The groups that this resource instance is a member of", + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + } + } + } + } + } + }, + "lifecycle-manager_resource-instance-search-params": { + "type": "object", + "additionalProperties": false, + "required": [], + "allOf": [ + { + "type": "object", + "properties": { + "skip": { + "description": "This parameter specifies where to start the returned page of search results.", + "type": "string" + }, + "limit": { + "description": "This parameter specifies how many items to return in the search results.", + "type": "string" + } + } + }, + { + "type": "object", + "properties": { + "sort": { + "description": "This parameter specifies the field to sort the search results over.", + "type": "string", + "examples": ["name", "created"] + }, + "order": { + "description": "This parameter specifies the direction to sort the search results over.", + "enum": ["asc", "desc"] + } + } + }, + { + "properties": { + "equals": { + "type": "object", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "stateName": { + "description": "The name of the current state of the resource instance", + "type": "string" + }, + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + }, + "modelId": {}, + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "createdBy": {}, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + }, + "lastUpdatedBy": {} + } + }, + "in": { + "allOf": [ + { + "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", + "type": "object", + "examples": [ + { + "stateId": "1234,53fe,0000" + }, + { + "name": "name1,name2,name3" + } + ] + }, + { + "type": "object", + "properties": { + "lastAction": { + "type": "object", + "properties": { + "type": { + "type": "array", + "items": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + } + } + } + } + } + } + ] + }, + "include-deleted": { + "type": "string", + "default": "false", + "enum": ["true", "false"] + }, + "starts-with": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource instance", + "examples": ["VLAN Service", "EC2 Instance"] + } + } + }, + "group": { + "type": "string", + "description": "An ID or name of an instance group to filter by", + "oneOf": [ + { + "type": "string", + "minLength": 1, + "description": "The name of the document", + "examples": ["myCoolDocumentName"] + }, + { + "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", + "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", + "type": "string", + "pattern": "^[0-9a-f]{24}$" + } + ] + }, + "instanceGroups": { + "type": "string", + "default": "false", + "enum": ["true", "false"] + }, + "lt": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + } + } + }, + "lte": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + } + } + }, + "gt": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + } + } + }, + "gte": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource instance was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource instance was last updated" + } + } + }, + "include": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "_id", + "name", + "description", + "modelId", + "instanceData", + "lastAction", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ] + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "_id", + "name", + "description", + "modelId", + "instanceData", + "lastAction", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ] + } + }, + "dereference": { + "description": "Comma-separated list of foreign key field types to dereference", + "const": "accounts" + } + } + } + ] + }, + "lifecycle-manager_resource-model-common_name": { + "type": "string", + "description": "The name of the resource model", + "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] + }, + "lifecycle-manager_resource-model-common_action-identifier": { + "description": "A 4-digit hexadecimal id", + "type": "string", + "pattern": "^[0-9a-fA-F]{4}$", + "examples": ["0a2f", "5341", "0000"] + }, + "lifecycle-manager_resource-model-common_action": { + "type": "object", + "required": [ + "_id", + "name", + "workflow", + "preWorkflowJst", + "postWorkflowJst", + "type" + ], + "additionalProperties": false, + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + }, + "lifecycle-manager_resource-model-common_actions": { + "type": "array", + "items": { + "type": "object", + "required": [ + "_id", + "name", + "workflow", + "preWorkflowJst", + "postWorkflowJst", + "type" + ], + "additionalProperties": false, + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + } + }, + "lifecycle-manager_resource-model-create-data": { + "type": "object", + "additionalProperties": false, + "required": ["name"], + "properties": { + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource model", + "default": "", + "examples": [ + "This resource model represents something we use on a day-to-day basis.", + "We use this to model one of the devices in our system.", + "This model tracks one of the elements of our cloud infrastructure." + ] + }, + "schema": { + "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "workflow", + "preWorkflowJst", + "postWorkflowJst", + "type" + ], + "additionalProperties": false, + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The _id of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "description": "The UUIDv4 identifying a workflow" + } + ] + } + } + } + } + } + }, + "lifecycle-manager_resource-model-export": { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "name", + "description", + "schema", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource model", + "default": "", + "examples": [ + "This resource model represents something we use on a day-to-day basis.", + "We use this to model one of the devices in our system.", + "This model tracks one of the elements of our cloud infrastructure." + ] + }, + "schema": { + "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + } + }, + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource model" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource model" + } + } + }, + "lifecycle-manager_resource-model-http": { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "name", + "description", + "schema", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource model", + "default": "", + "examples": [ + "This resource model represents something we use on a day-to-day basis.", + "We use this to model one of the devices in our system.", + "This model tracks one of the elements of our cloud infrastructure." + ] + }, + "schema": { + "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "required": [ + "_id", + "name", + "workflow", + "preWorkflowJst", + "postWorkflowJst", + "type" + ], + "additionalProperties": false, + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The _id of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "description": "The UUIDv4 identifying a workflow" + } + ] + }, + "inputSchema": { + "description": "The schema describing inputs to this action", + "type": "object" + }, + "outputSchema": { + "description": "The schema describing inputs to this action", + "type": "object" + } + } + } + }, + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource model" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource model" + } + } + }, + "lifecycle-manager_resource-model-import": { + "type": "object", + "additionalProperties": false, + "required": ["model"], + "properties": { + "model": { + "type": "object", + "additionalProperties": false, + "required": [ + "_id", + "name", + "description", + "schema", + "created", + "createdBy", + "lastUpdated", + "lastUpdatedBy" + ], + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "description": { + "type": "string", + "description": "Free-form text describing the resource model", + "default": "", + "examples": [ + "This resource model represents something we use on a day-to-day basis.", + "We use this to model one of the devices in our system.", + "This model tracks one of the elements of our cloud infrastructure." + ] + }, + "schema": { + "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + } + }, + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "createdBy": { + "description": "The account identifier of the user who created this resource model" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + }, + "lastUpdatedBy": { + "description": "The account identifier of the user who last updated this resource model" + } + }, + "definitions": { + "action-workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "action": { + "type": "object", + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + }, + "actions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_id": { + "description": "The identifier of an action" + }, + "name": { + "description": "The name of the action", + "type": "string", + "examples": ["Create", "Update", "Suspend", "Reboot"] + }, + "type": { + "description": "The type of the action", + "enum": ["import", "create", "update", "delete"] + }, + "preWorkflowJst": { + "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + }, + "workflow": { + "description": "The name of the workflow to use as the implementation of this action.", + "oneOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "postWorkflowJst": { + "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", + "oneOf": [ + { + "type": "null" + }, + { + "title": "MongoDB.ObjectId", + "description": "A MongoDB ObjectId", + "type": "string", + "pattern": "^[0-9a-fA-F]{24}$", + "examples": ["62a1f3d2ebedfc54e6e0065c"] + } + ] + } + } + } + } + } + }, + "overwrite": { + "type": "boolean" + } + } + }, + "lifecycle-manager_resource-model-search-params": { + "type": "object", + "additionalProperties": false, + "required": [], + "allOf": [ + { + "type": "object", + "properties": { + "skip": { + "description": "This parameter specifies where to start the returned page of search results.", + "type": "string" + }, + "limit": { + "description": "This parameter specifies how many items to return in the search results.", + "type": "string" + } + } + }, + { + "type": "object", + "properties": { + "sort": { + "description": "This parameter specifies the field to sort the search results over.", + "type": "string", + "examples": ["name", "created"] + }, + "order": { + "description": "This parameter specifies the direction to sort the search results over.", + "enum": ["asc", "desc"] + } + } + }, + { + "type": "object", + "properties": { + "equals": { + "type": "object", + "properties": { + "_id": {}, + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + }, + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "starts-with": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + } + } + }, + "contains": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource model", + "examples": [ + "VLAN Service", + "EC2 Instance", + "ServiceNow Ticket" + ] + } + } + }, + "lt": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "lte": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "gt": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "gte": { + "type": "object", + "properties": { + "created": { + "description": "An ISO date string denoting when this resource model was created" + }, + "lastUpdated": { + "description": "An ISO date string denoting when this resource model was last updated" + } + } + }, + "dereference": { + "description": "Comma-separated list of field types to dereference", + "type": "string" + } + } + } + ] + } + }, + "securitySchemes": { + "CookieAuth": { + "type": "apiKey", + "name": "token", + "in": "cookie" + }, + "QueryAuth": { + "type": "apiKey", + "name": "token", + "in": "query" + }, + "BasicAuth": { + "type": "http", + "scheme": "basic" + } + } + } +} From 536f901e0a19b94e251bbfd3b8c6f14e42cfb366 Mon Sep 17 00:00:00 2001 From: Travis Delker Date: Thu, 3 Jul 2025 16:18:40 -0400 Subject: [PATCH 2/2] simplified API specs to 1 method --- .../OpenAPISpecs/OpenApiWhoamI-BasicAuth.json | 60 + .../OpenApiWhoamI-ClientCreds.json | 53 + .../platform6-OAuth-ClientCreds.json | 79532 --------------- Itential/Platform/OpenAPISpecs/platform6.json | 79608 ---------------- 4 files changed, 113 insertions(+), 159140 deletions(-) create mode 100644 Itential/Platform/OpenAPISpecs/OpenApiWhoamI-BasicAuth.json create mode 100644 Itential/Platform/OpenAPISpecs/OpenApiWhoamI-ClientCreds.json delete mode 100644 Itential/Platform/OpenAPISpecs/platform6-OAuth-ClientCreds.json delete mode 100644 Itential/Platform/OpenAPISpecs/platform6.json diff --git a/Itential/Platform/OpenAPISpecs/OpenApiWhoamI-BasicAuth.json b/Itential/Platform/OpenAPISpecs/OpenApiWhoamI-BasicAuth.json new file mode 100644 index 0000000..9640983 --- /dev/null +++ b/Itential/Platform/OpenAPISpecs/OpenApiWhoamI-BasicAuth.json @@ -0,0 +1,60 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "IAP", + "version": "1.0.0", + "description": "A simple OpenAPI example" + }, + "paths": { + "/whoami": { + "get": { + "summary": "Gets the authorization data for the logged in user", + "description": "Gets the authorization data for the logged in user", + "tags": ["authentication"], + "operationId": "WhoAmI", + "responses": { + "200": { + "description": "Authorization data for a user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "QueryAuth": [], + "CookieAuth": [], + "BasicAuth": [] + } + ] + } + } + }, + "components": { + "securitySchemes":{ + "CookieAuth": { + "type": "apiKey", + "name": "token", + "in": "cookie" + }, + "QueryAuth": { + "type": "apiKey", + "name": "token", + "in": "query" + }, + "BasicAuth": { + "type": "http", + "scheme": "basic" + } + } + } +} \ No newline at end of file diff --git a/Itential/Platform/OpenAPISpecs/OpenApiWhoamI-ClientCreds.json b/Itential/Platform/OpenAPISpecs/OpenApiWhoamI-ClientCreds.json new file mode 100644 index 0000000..36ef164 --- /dev/null +++ b/Itential/Platform/OpenAPISpecs/OpenApiWhoamI-ClientCreds.json @@ -0,0 +1,53 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "IAP", + "version": "1.0.0", + "description": "A simple OpenAPI example" + }, + "paths": { + "/whoami": { + "get": { + "summary": "Gets the authorization data for the logged in user", + "description": "Gets the authorization data for the logged in user", + "tags": ["authentication"], + "operationId": "WhoAmI", + "responses": { + "200": { + "description": "Authorization data for a user", + "content": { + "application/json": { + "schema": { + "title": "result", + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "Error response from API" + } + }, + "security": [ + { + "ServiceAccount": [] + } + ] + } + } + }, + "components": { + "securitySchemes": { + "ServiceAccount": { + "type": "oauth2", + "flows": { + "clientCredentials": { + "tokenUrl": "https://platform/oauth/token", + "scopes": {} + } + } + } + } + } +} \ No newline at end of file diff --git a/Itential/Platform/OpenAPISpecs/platform6-OAuth-ClientCreds.json b/Itential/Platform/OpenAPISpecs/platform6-OAuth-ClientCreds.json deleted file mode 100644 index a6cdfe4..0000000 --- a/Itential/Platform/OpenAPISpecs/platform6-OAuth-ClientCreds.json +++ /dev/null @@ -1,79532 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "Oauth-Platform 6", - "description": "Platform 6 REST API for Application Integration.", - "version": "1.0.0", - "x-logo": { - "url": "https://www.itential.com/wp-content/uploads/2022/08/Color-Variation-White.png", - "backgroundColor": "#FFFFFF", - "altText": "Itential logo" - } - }, - "servers": [ - { - "url": "{protocol}://{server}:{port}", - "variables": { - "protocol": { - "default": "http", - "description": "The server protocol" - }, - "server": { - "default": "localhost", - "description": "The server IP or DNS" - }, - "port": { - "default": "3000", - "description": "The server port" - } - } - } - ], - "x-tagGroups": [ - { - "name": "Home", - "tags": ["home-about", "home-baseline"] - }, - { - "name": "Authentication", - "tags": ["auth-reqs", "auth-basic", "auth-query-token", "auth-client"] - }, - { - "name": "Getting Started", - "tags": [ - "example-whoami-basic", - "example-whoami-query-token", - "example-whoami-client-bearer-token" - ] - }, - { - "name": "API Reference", - "tags": [ - "api-reference", - "adapter-models", - "adapters", - "ag-manager", - "applications", - "authentication", - "authorization", - "automation-studio", - "configuration_manager", - "customization", - "device-counts", - "external-links", - "git", - "group-mappings", - "health", - "help", - "indexes", - "integration-models", - "integrations", - "json-forms", - "lifecycle-manager", - "mop", - "oauth", - "operations-manager", - "profiles", - "schema", - "search", - "sso", - "tags", - "template_builder", - "transformations", - "user", - "workflow_builder", - "workflow_engine" - ] - } - ], - "tags": [ - { - "name": "home-about", - "x-displayName": "About", - "description": "The Itential REST API uses OpenAPI 3.1.0 specifications and supports Basic Authentication and OAuth 2.0 to authenticate requests. This reference library documents available APIs for the Platform 6, including HTTP response codes to indicate success or failure of an API request. Platform 6 REST APIs also use standard verbs to perform CRUD operations. For product documentation, visit [Itential Documentation & Guides](https://docs.itential.com/v1/en).\n
" - }, - { - "name": "home-baseline", - "x-displayName": "Ports and Base Path", - "description": "Default HTTP port is `3000`. Default HTTPS port is `3443`. Both IPv6 and IPv4 are supported. Default host is `127.0.0.1`. The basePath is `/`.\n
\n" - }, - { - "name": "auth-reqs", - "x-displayName": "Authentication", - "description": "API requests without authentication will fail. Available authorizations include: `BasicAuth` (username/password), `CookieAuth`(token/cookie-based) and `OAuth` (token/query-based).\n
\n" - }, - { - "name": "auth-basic", - "x-displayName": "Basic Auth", - "description": "

This API uses Basic Authentication for securing its endpoints.

\n\n

How to Use Basic Authentication

\n

Using this authentication strategy, you need to provide your credentials in the HTTP request headers. The credentials should be sent as a base64 encoded string of username:password.

\n\n

Example: Using curl for Basic Authentication

\n
\n curl -u username:password -X GET \"https://localhost:3443\"\n
\n\n

In this example, -u is the flag used by curl to specify the username and password. Replace username and password with your actual credentials.

\n\n

HTTP Request Headers

\n

The Basic Authentication credentials are sent in the Authorization header. Here's what it looks like:

\n
\n Authorization: Basic base64(username:password)\n
\n\n

Base64 Encoding

\n

The username:password string needs to be base64 encoded before it is sent in the header. For example, if your username is user and your password is pass, the string to encode is user:pass. The base64 encoded result would look something like this:

\n
\n Authorization: Basic dXNlcjpwYXNz\n
\n" - }, - { - "name": "auth-query-token", - "x-displayName": "Query Token", - "description": "

Authentication

\n

Using this authentication strategy, you need to authenticate and obtain a token by making a POST request to the /login endpoint. The response token will be used in the token query parameter for subsequent requests.

\n\n

How to Request a Token

\n

To obtain an authentication token, send a POST request to the /login endpoint with the following JSON payload:

\n\n
\n \n {\n \"user\": {\n \"username\": \"admin\",\n \"password\": \"admin\"\n }\n }\n \n
\n\n

Example: Using curl to Request a Token

\n
\n curl -X POST \"https://localhost:3443/login\" -H \"Content-Type: application/json\" -d '{\"user\": {\"username\": \"admin\", \"password\": \"admin\"}}'\n
\n\n

In this example, the -d flag is used by curl to send the JSON body with the request.

\n\n

Response

\n

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

\n\n
\n \n your-auth-token-here\n \n
\n\n

Using the Token in Subsequent Requests

\n

Once you have the token, include it in the query string of your requests as follows:

\n\n
\n ?token=your-auth-token-here\n
\n" - }, - { - "name": "auth-client", - "x-displayName": "Client Auth", - "description": "

Authentication

\n

Using this authentication strategy, you need to authenticate and obtain a Bearer token by making a POST request to the /oauth/token endpoint. The response access_token will be used as temporary credentials that the client will set in the Authorization header. Here's what it looks like:

\n
\n Authorization: Basic access_token\n
\n\n.

\n\n

How to Request a Token

\n

To obtain an authentication token, send a POST request to the /oauth/token endpoint. You'll need to send the data as application/x-www-form-urlencoded with the following payload:

\n\n
\n client_id=your-client-id&client_secret=your-client-secret&grant_type=client_credentials\n
\n\n

Example: Using curl to Request a Bearer Token

\n
\n curl -X POST \"https://localhost:3443/oauth/token\" -H \"Content-Type: accept: application/json\" -H \"Content-Type: application/x-www-form-urlencoded\" -d 'client_id=123abccc123a123a12ab1ab1&client_secret=a123a123-a1a1-1a1a-a123-123a12abc1a1&grant_type=client_credentials'\n
\n\n

In this example, the -d flag is used by curl to send the data with the request.

\n\n

Response

\n

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

\n\n
\n\n{\n\"access_token\": \"falksjflkasdjflkasdjfklajsdflj.eyJwcmluY2lwYWxJZCI6IjY2OWU1ZGNjOTE1ZDUxMWEzMmJmMGNhNCIsImV4cCI6MTcyMTY1OTQ4MDkwMiwiaWF0IjoxNzIxNjU1ODgwfQ.7jrB2mC9aqSdPdUvz7D-u9HghRFtnpFbYdaBH54kNZc\",\"token_type\": \"bearer\",\"expires_in\": 3600}\n \n
\n\n

Using the Bearer Token in Subsequent Requests

\n

Once you have the Bearer token, use it as your Authorization header. Here's what it should look like:

\n\n
\n Authorization: Bearer your-access_token-here\n
\n" - }, - { - "name": "example-whoami-basic", - "x-displayName": "Example (whoami) - Basic Auth", - "description": "To test the API using Basic Authentication, you can use the following\n`curl` command. Replace `username` and `password` with your actual\ncredentials.\n\nNote: Basic Auth is only available over SSL.\n\n\n
\n curl -u username:password -X GET \"https://localhost:3443/whoami\"\n
\n\nThis command sends a GET request to the specified resource, using the\nprovided username and password for authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" - }, - { - "name": "example-whoami-query-token", - "x-displayName": "Example (whoami) - Query Token", - "description": "To test the API using the Query Token Authentication, you can use the following\n`curl` command. Replace `your-auth-token-here` with your actual\ntoken that you received using `/login`.\n\n\n
\n curl -X GET \"https://localhost:3443/whoami?token=your-auth-token-here\"\n
\n\nThis command sends a GET request to the specified resource, using the\nQuery Token authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" - }, - { - "name": "example-whoami-client-bearer-token", - "x-displayName": "Example (whoami) - Client Bearer Token", - "description": "To test the API using the Client Authentication, you can use the following\n`curl` command. Replace `your-access_token-here` with your actual\nBearer token that you received using `/oauth/token`.\n\n\n
\n curl -X GET \"https://localhost:3443/whoami\" -H \"Authorization: Bearer your-access_token-here\" \n
\n\nThis command sends a GET request to the specified resource, using the\nClient authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" - }, - { - "name": "adapter-models", - "x-displayName": "Adapter Models" - }, - { - "name": "adapters", - "x-displayName": "Adapters" - }, - { - "name": "ag-manager", - "x-displayName": "Automation Gateway" - }, - { - "name": "applications", - "x-displayName": "Applications" - }, - { - "name": "authentication", - "x-displayName": "Authentication" - }, - { - "name": "authorization", - "x-displayName": "Authorization" - }, - { - "name": "automation-studio", - "x-displayName": "Automation Studio", - "description": "A suite of tools for designing workflows, templates, and forms." - }, - { - "name": "configuration_manager", - "description": "Unified manager application for devices and configurations" - }, - { - "name": "configuration_manager", - "x-displayName": "Configuration Manager" - }, - { - "name": "customization", - "x-displayName": "Customization" - }, - { - "name": "device-counts", - "x-displayName": "Device Counts" - }, - { - "name": "external-links", - "x-displayName": "External Links" - }, - { - "name": "formbuilder", - "description": "API to generate dynamic forms" - }, - { - "name": "git", - "x-displayName": "Git" - }, - { - "name": "group-mappings", - "x-displayName": "Group Mappings" - }, - { - "name": "health", - "x-displayName": "Health" - }, - { - "name": "help", - "x-displayName": "Help", - "description": "Documentation Help" - }, - { - "name": "indexes", - "x-displayName": "Indexes" - }, - { - "name": "integration-models", - "x-displayName": "Integration Models" - }, - { - "name": "integrations", - "x-displayName": "Integrations" - }, - { - "name": "json-forms", - "x-displayName": "JSON Forms", - "description": "An application to create, edit, and publish forms based on JSON documents." - }, - { - "name": "lifecycle-manager", - "x-displayName": "Lifecycle Manager" - }, - { - "name": "mop", - "x-displayName": "Command Templates (MOP)" - }, - { - "name": "oauth", - "x-displayName": "OAuth" - }, - { - "name": "operations-manager", - "x-displayName": "Operations Manager" - }, - { - "name": "prebuilts", - "description": "Pre-Builts API" - }, - { - "name": "prebuilts-repository", - "description": "Pre-Builts Repository API" - }, - { - "name": "profiles", - "x-displayName": "Profiles" - }, - { - "name": "prometheus_metrics", - "x-displayName": "Prometheus Metrics" - }, - { - "name": "schema", - "x-displayName": "Schema" - }, - { - "name": "search", - "x-displayName": "Search" - }, - { - "name": "sso", - "x-displayName": "Single Sign On" - }, - { - "name": "tags", - "x-displayName": "Tags" - }, - { - "name": "template_builder", - "x-displayName": "Template Builder" - }, - { - "name": "transformations", - "x-displayName": "Transformations" - }, - { - "name": "user", - "x-displayName": "User" - }, - { - "name": "workflow_builder", - "x-displayName": "Workflow Builder" - }, - { - "name": "workflow_engine", - "x-displayName": "Workflow Engine" - } - ], - "paths": { - "/adapters": { - "post": { - "summary": "Create a new adapter.", - "description": "Create a new adapter in IAP.", - "tags": ["adapters"], - "parameters": [], - "operationId": "Adapters.createAdapter", - "responses": { - "200": { - "description": "The result of the adapter creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "model": { - "$ref": "#/components/schemas/iap_services-schema_model" - }, - "name": { - "$ref": "#/components/schemas/iap_services-schema_name" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "title": "id", - "description": "The id for the service", - "const": { - "$data": "2/name" - }, - "examples": ["Local AAA"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of an adapter", - "examples": ["local_aaa", "Redis", "Email"] - }, - "properties": { - "type": "object", - "properties": {} - }, - "brokers": { - "type": "array", - "description": "Brokers which utilize this service", - "items": { - "type": "string", - "description": "Name of the broker", - "examples": ["aaa"] - } - }, - "groups": { - "type": "array", - "description": "Groups which can use this service", - "items": { - "type": "string", - "description": "Name of the group", - "examples": ["pronghorn_admin"] - } - } - }, - "required": ["id", "type"] - } - }, - "required": ["name", "type", "properties"] - } - } - } - } - } - } - }, - "get": { - "summary": "Get all adapters.", - "description": "Get all adapters in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "skipActiveSync", - "in": "query", - "description": "skipActiveSync", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - } - ], - "operationId": "Adapters.getAdapters", - "responses": { - "200": { - "description": "Contains an array of adapters and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": false - } - }, - "/adapters/import": { - "post": { - "summary": "Import a new adapter.", - "description": "Import a new adapter in IAP.", - "tags": ["adapters"], - "parameters": [], - "operationId": "Adapters.importAdapter", - "responses": { - "200": { - "description": "The result of the adapter import process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "model": { - "$ref": "#/components/schemas/iap_services-schema_model" - }, - "name": { - "$ref": "#/components/schemas/iap_services-schema_name" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "migrationVersion": { - "type": "integer", - "minimum": 0 - }, - "properties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "title": "id", - "description": "The id for the service", - "const": { - "$data": "2/name" - }, - "examples": ["Local AAA"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of an adapter", - "examples": ["local_aaa", "Redis", "Email"] - }, - "properties": { - "type": "object", - "properties": {} - }, - "brokers": { - "type": "array", - "description": "Brokers which utilize this service", - "items": { - "type": "string", - "description": "Name of the broker", - "examples": ["aaa"] - } - }, - "groups": { - "type": "array", - "description": "Groups which can use this service", - "items": { - "type": "string", - "description": "Name of the group", - "examples": ["pronghorn_admin"] - } - } - }, - "required": ["id", "type"] - } - }, - "required": ["name", "type", "properties"] - } - } - } - } - } - } - } - }, - "/adapters/{name}": { - "delete": { - "summary": "Delete an adapter.", - "description": "Delete an adapter from IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.deleteAdapter", - "responses": { - "200": { - "description": "The output of the adapter deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a single adapter.", - "description": "Get a single adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.getAdapter", - "responses": { - "200": { - "description": "Contains the data of a single adapter.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an adapter.", - "description": "Update an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.updateAdapter", - "responses": { - "200": { - "description": "The output of the adapter update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "$ref": "#/components/schemas/iap_services-schema_properties" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/adapters/{name}/export": { - "get": { - "summary": "Export a single adapter.", - "description": "Export a single adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.exportAdapter", - "responses": { - "200": { - "description": "Contains the data of a single adapter.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": false - } - }, - "/adapters/{name}/changelogs": { - "get": { - "summary": "Get the list of changelogs.", - "description": "Get the list of changelogs for a specific adapter.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["WorkFlowEngine", "MOP"] - } - }, - { - "name": "release", - "in": "query", - "description": "release", - "required": false, - "schema": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - } - } - ], - "operationId": "Adapters.getAdapterChangelogs", - "responses": { - "200": { - "description": "The list of changelogs available for the requested adapter.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "string", - "examples": [ - { - "2020.1.1": "Changelog for 2020.1" - } - ], - "pattern": "^[0-9]{4}[.][0-9]{1,}[.][0-9]{1,}$" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": true - } - }, - "/adapters/{name}/start": { - "put": { - "summary": "Start an adapter.", - "description": "Start an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.startAdapter", - "responses": { - "200": { - "description": "The result of the start process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin"] - } - ], - "deprecated": false - } - }, - "/adapters/{name}/stop": { - "put": { - "summary": "Stop an adapter.", - "description": "Stop an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.stopAdapter", - "responses": { - "200": { - "description": "The result of the stop process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin"] - } - ], - "deprecated": false - } - }, - "/adapters/{name}/restart": { - "put": { - "summary": "Restart an adapter.", - "description": "Restart an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.restartAdapter", - "responses": { - "200": { - "description": "The result of the restart process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin"] - } - ], - "deprecated": false - } - }, - "/adapters/{name}/loglevel": { - "put": { - "summary": "Update the log levels.", - "description": "Update the log levels for an adapter.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.updateAdapterLogging", - "responses": { - "200": { - "description": "The result of updating the log levels for an adapter.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "transport": { - "type": "string", - "enum": ["file", "console", "syslog"] - } - }, - "if": { - "properties": { - "transport": { - "const": "syslog" - } - } - }, - "then": { - "properties": { - "level": { - "$ref": "#/components/schemas/iap_services-schema_sys_log_level" - } - } - }, - "else": { - "properties": { - "level": { - "$ref": "#/components/schemas/iap_services-schema_log_level" - } - } - } - } - } - } - } - } - } - } - }, - "/adapters/{name}/properties": { - "put": { - "summary": "Update the properties of an adapter.", - "description": "Update the properties of an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.updateAdapterProperties", - "responses": { - "200": { - "description": "The output of the adapter properties update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties" - } - } - } - } - } - } - } - }, - "/adapters/brokers/mapping": { - "get": { - "summary": "Get a mapping between brokers and adapters.", - "description": "Get a mapping between brokers and adapters.", - "tags": ["adapters"], - "parameters": [], - "operationId": "Adapters.getBrokerMap", - "responses": { - "200": { - "description": "Mapping between brokers and adapters in IAP.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "examples": [ - { - "aaa": ["Local AAA"] - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": false - } - }, - "/whoami": { - "get": { - "summary": "Gets the authorization data for the logged in user", - "description": "Gets the authorization data for the logged in user", - "tags": ["authentication"], - "parameters": [ - { - "name": "roles", - "in": "query", - "description": "roles", - "required": false, - "schema": { - "type": "string", - "enum": ["names", "ids"] - } - } - ], - "operationId": "Authentication.whoAmI", - "responses": { - "200": { - "description": "Authorization data for a user", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "type": "string", - "description": "The name of the AAA adapter from which the user logged in", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "description": "The username of the logged in user", - "examples": ["jane_doe"] - }, - "firstname": { - "type": "string", - "description": "The first name of the logged in user", - "examples": ["Jane"] - }, - "groups": { - "type": "array", - "description": "An array of groups which contain the logged in user", - "items": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "type": "string", - "description": "The name of the AAA adapter which contains the group", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "description": "The name of the group", - "examples": ["admin_group"] - } - } - } - }, - "roles": { - "type": "array", - "description": "Array of roles user has access to", - "items": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - }, - "roleNames": { - "type": "array", - "description": "Array of role names that user has access to", - "items": { - "type": "string" - } - }, - "routes": { - "type": "array", - "description": "Array of routes logged in user has access to", - "items": { - "type": "string", - "examples": ["/admin/"] - } - }, - "methods": { - "type": "object", - "description": "Map of service names and method names which the user has access to", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "description": "The name of a method within an application", - "examples": ["getProfiles"] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/mySession": { - "get": { - "summary": "Gets the session document for the active user", - "description": "Gets the session for the active user", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getMySession", - "responses": { - "200": { - "description": "The session document for the logged in user.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The session token for the logged in user" - }, - "loginMethod": { - "type": "string", - "description": "The way a user logged in", - "enum": ["Web", "sudo"] - }, - "session_start": { - "type": "integer", - "description": "The Unix epoch time when the session started" - }, - "ttl": { - "type": "integer", - "description": "The default ttl for a user session" - }, - "principalId": { - "type": "string", - "description": "The accountId for the logged in user" - }, - "requestCount": { - "type": "integer", - "description": "The number of API requests made during the active session" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/myPrincipal": { - "get": { - "summary": "Gets the principal document for the active user", - "description": "Gets the principal for the active user", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getMyPrincipal", - "responses": { - "200": { - "description": "The principal document for the logged in user", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "type": "string", - "description": "The name of the AAA adapter from which the user logged in", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "description": "The username of the logged in user", - "examples": ["jane_doe"] - }, - "firstname": { - "type": "string", - "description": "The first name of the logged in user", - "examples": ["Jane"] - }, - "groups": { - "type": "array", - "description": "An array of groups which contain the logged in user", - "items": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "type": "string", - "description": "The name of the AAA adapter which contains the group", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "description": "The name of the group", - "examples": ["admin_group"] - } - } - } - }, - "roles": { - "type": "array", - "description": "Array of roles user has access to", - "items": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - }, - "roleNames": { - "type": "array", - "description": "Array of role names user has access to", - "items": { - "type": "string" - } - }, - "allowedMethods": { - "type": "array", - "description": "The API methods which a user has access to", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "description": "The service which contains the method", - "examples": ["AutomationStudio"] - }, - "name": { - "type": "string", - "description": "The name of the method", - "examples": ["getTemplates"] - } - } - } - }, - "allowedViews": { - "type": "array", - "description": "The URL pages which a user has access to", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "description": "The service which contains the view", - "examples": ["AutomationStudio"] - }, - "path": { - "type": "string", - "description": "The URL route to the view", - "examples": ["/automation-studio/"] - } - } - } - }, - "routes": { - "type": "array", - "description": "Array of routes logged in user has access to", - "items": { - "type": "string", - "examples": ["/admin/"] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/myTtl": { - "get": { - "summary": "Get the number of seconds until the logged in user's session expires.", - "description": "Get the number of seconds until the user is logged out.", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getMyTtl", - "responses": { - "200": { - "description": "The number of seconds until the logged in user's session expires", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "integer" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/sso": { - "get": { - "summary": "Log in and create a session in IAP using single sign on", - "description": "Log into IAP using single sign on", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.sso", - "responses": { - "200": { - "description": "No output.", - "content": { - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/sso/test/{name}": { - "get": { - "summary": "Test logging into IAP using a saved single sign on configuration", - "description": "Test logging into IAP using single sign on", - "tags": ["authentication"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "Authentication.ssoTest", - "responses": { - "200": { - "description": "No output.", - "content": { - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/saml/callback": { - "post": { - "summary": "This the route used by the SAML identity provider to callback to IAP with the authentication response. This is not meant for manual use.", - "description": "Callback used by the SAML identity provider", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.samlCallback", - "responses": { - "200": { - "description": "No output.", - "content": { - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/sso/enabled": { - "get": { - "summary": "Get whether or not single sign on is enabled", - "description": "Get whether or not single sign on is enabled", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.isSSOEnabled", - "responses": { - "200": { - "description": "Whether or not single sign on is enabled", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/login": { - "post": { - "summary": "Log in an create a session in IAP", - "description": "Log in to IAP", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.login", - "responses": { - "200": { - "description": "The session token for a logged in user", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string", - "examples": ["MTQ4ZmMzMGMxOTQ2MTg4N2ZjMDhiMTY0MzlkYTgwZmM="] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false, - "requestBody": { - "description": "credentials", - "content": { - "application/json": { - "schema": { - "title": "credentials", - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - } - } - } - } - } - } - } - }, - "/logout": { - "get": { - "summary": "Log out of IAP and delete current session", - "description": "Log out of IAP", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.logout", - "responses": { - "200": { - "description": "The return data from logging out", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string", - "examples": ["You have successfully logged out."] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/download": { - "get": { - "summary": "Download a public file from IAP", - "description": "Download a public file from IAP", - "tags": ["authentication"], - "parameters": [ - { - "name": "file_name", - "in": "query", - "description": "file_name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "operationId": "Authentication.download", - "responses": { - "200": { - "description": "The contents of the file downloaded", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string", - "examples": ["this is the contents of a file"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/system/id": { - "get": { - "summary": "Get system server id.", - "description": "Get system server id for the current IAP.", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getSystemId", - "responses": { - "200": { - "description": "serverId of the current IAP.", - "content": { - "application/json": { - "schema": { - "title": "serverId", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/version": { - "get": { - "summary": "Get verion.", - "description": "Get release verion of current IAP.", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getReleaseVersion", - "responses": { - "200": { - "description": "Release Version of the current IAP.", - "content": { - "application/json": { - "schema": { - "title": "releaseVersion", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/config/apps": { - "get": { - "summary": "Get all application configs in IAP.", - "description": "Get all application configs in IAP.", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getApplicationConfigs", - "responses": { - "200": { - "description": "Contains the configuration of all applications.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "title": "id", - "type": "string" - }, - "export": { - "title": "export", - "type": "string" - }, - "title": { - "title": "title", - "type": "string" - }, - "type": { - "title": "type", - "type": "string" - }, - "summary": { - "title": "summary", - "type": "string" - }, - "pdb": { - "title": "pdb", - "type": "boolean" - }, - "roles": { - "title": "roles", - "type": "array", - "items": { - "type": "string" - } - }, - "methods": { - "title": "methods", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "description": { - "title": "description", - "type": "string" - }, - "summary": { - "title": "summary", - "type": "string" - }, - "deprecated": { - "title": "deprecated", - "type": "boolean" - }, - "roles": { - "title": "roles", - "type": "array", - "items": { - "type": "string" - } - }, - "route": { - "title": "route", - "type": "object", - "properties": { - "path": { - "title": "path", - "type": "string" - }, - "verb": { - "title": "verb", - "type": "string" - } - } - }, - "input": { - "title": "input", - "type": "array", - "items": { - "type": "object" - } - }, - "output": { - "title": "output", - "type": "object" - } - } - } - }, - "views": { - "title": "views", - "type": "array", - "items": { - "type": "object" - } - }, - "src": { - "title": "src", - "type": "string" - }, - "encrypted": { - "title": "encrypted", - "type": "boolean" - }, - "version": { - "title": "version", - "type": "string" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/profile/{username}": { - "get": { - "summary": "Gets the user profile for the active user", - "description": "Gets the user profile for the active user", - "tags": ["authentication"], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The exact username for the logged in user", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema_username" - } - } - ], - "operationId": "Authentication.getUserProfile", - "responses": { - "200": { - "description": "The account document for the logged in user.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": true - } - }, - "/profile/update": { - "put": { - "summary": "Updates the user profile for the active user", - "description": "Updates the user profile for the active user", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.updateUserProfile", - "responses": { - "200": { - "description": "Updated account document for current user", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": true, - "requestBody": { - "description": "userProfile", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "username": { - "$ref": "#/components/schemas/iap_accounts-schema_username" - }, - "email": { - "$ref": "#/components/schemas/iap_accounts-schema_email" - } - }, - "required": ["username"], - "additionalProperties": false - } - } - } - } - } - }, - "/adapter-models/types": { - "get": { - "summary": "Get the list of available adapter model types.", - "description": "Get the list of available adapter model types in the current IAP.", - "tags": ["adapter-models"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["profile1"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["profile1"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["profile"] - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "AdapterModels.getAdapterModelTypes", - "responses": { - "200": { - "description": "Contains an array of adapter model types and the total.", - "content": { - "application/json": { - "schema": { - "title": "adapterModels", - "type": "object", - "required": ["adapterModels", "total"], - "properties": { - "adapterModels": { - "type": "array", - "items": { - "type": "string", - "examples": ["local_aaa", "redis"] - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AdapterModels.admin", "AdapterModels.apiread"], - "CookieAuth": ["AdapterModels.admin", "AdapterModels.apiread"], - "BasicAuth": ["AdapterModels.admin", "AdapterModels.apiread"] - } - ], - "deprecated": false - } - }, - "/integration-models": { - "post": { - "summary": "Create a new integration model.", - "description": "Create a new integration model in IAP.", - "tags": ["integration-models"], - "parameters": [], - "operationId": "IntegrationModels.createIntegrationModel", - "responses": { - "200": { - "description": "The output of the integration model creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "type": "object", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "model": { - "title": "model", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - } - }, - "get": { - "summary": "Get all integration models.", - "description": "Get all the integration models in IAP.", - "tags": ["integration-models"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "Filter the response based on each item that includes the provided query.", - "required": false, - "schema": { - "type": "string", - "description": "Filter the response based on each item that includes the provided query.", - "examples": ["git", "hub", "v5"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "enum": ["versionId"] - } - }, - { - "name": "equals", - "in": "query", - "description": "Filter the response based on each item that is an exact match to the provided query.", - "required": false, - "schema": { - "type": "string", - "description": "Filter the response based on each item that is an exact match to the provided query.", - "examples": ["GitHub:v5"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "enum": ["versionId"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "Filter the response based on each item that starts with the provided query.", - "required": false, - "schema": { - "type": "string", - "description": "Filter the response based on each item that starts with the provided query.", - "examples": ["g"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "enum": ["versionId"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by. Default is versionId.", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by. Default is versionId.", - "enum": ["versionId"] - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "IntegrationModels.getIntegrationModels", - "responses": { - "200": { - "description": "Contains the data for all integration models.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "integrationModels": { - "type": "object", - "properties": { - "model": { - "type": "string", - "examples": ["@itential/adapter_GitHub:v5"] - }, - "versionId": { - "type": "string", - "examples": ["GitHub:v5"] - }, - "description": { - "type": "string", - "examples": [ - "A standard description about the integration model" - ] - }, - "properties": { - "type": "object", - "description": "Refer to OpenAPI specifications for the available properties for this OpenAPI document." - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ], - "CookieAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ], - "BasicAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an integration model.", - "description": "Update an integration model in IAP.", - "tags": ["integration-models"], - "parameters": [], - "operationId": "IntegrationModels.updateIntegrationModel", - "responses": { - "200": { - "description": "The output of the update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "type": "object", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "model": { - "title": "model", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - } - } - }, - "/integration-models/{name}": { - "delete": { - "summary": "Delete an integration model.", - "description": "Delete an integration model from IAP.", - "tags": ["integration-models"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the integration model.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["GitHub:v5"] - } - } - ], - "operationId": "IntegrationModels.deleteIntegrationModel", - "responses": { - "200": { - "description": "The output of the integration model deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a specific integration model.", - "description": "Get a specific integration model in IAP.", - "tags": ["integration-models"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the integration model.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["Gitlab:v5"] - } - } - ], - "operationId": "IntegrationModels.getIntegrationModel", - "responses": { - "200": { - "description": "Contains the data for a specific integration model.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "model": { - "type": "string", - "examples": ["@itential/adapter_GitHub:v5"] - }, - "versionId": { - "type": "string", - "examples": ["GitHub:v5"] - }, - "description": { - "type": "string", - "examples": [ - "A standard description about the integration model" - ] - }, - "properties": { - "type": "object", - "description": "Refer to OpenAPI specifications for the available properties for this OpenAPI document." - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ], - "CookieAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ], - "BasicAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ] - } - ], - "deprecated": false - } - }, - "/integration-models/{name}/export": { - "get": { - "summary": "Export an integration model.", - "description": "Export an integration model's open API spec.", - "tags": ["integration-models"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the integration model.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["GitHub:v5"] - } - } - ], - "operationId": "IntegrationModels.exportIntegrationModel", - "responses": { - "200": { - "description": "The integration model open api spec.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document.", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false - } - }, - "/integration-models/{name}/securitySchemes": { - "get": { - "summary": "Gets an integration model's security schemes.", - "description": "Projection simplification for exportIntegrationModel", - "tags": ["integration-models"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the integration model.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["GitHub:v5"] - } - } - ], - "operationId": "IntegrationModels.getIntegrationModelSecuritySchemes", - "responses": { - "200": { - "description": "The integration model's security schemes according to its open api spec.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "description": "Refer to OpenAPI specifications for the structure of the security schemes of an OpenAPI document.", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false - } - }, - "/integration-models/validation": { - "put": { - "summary": "Validate an integration model.", - "description": "Validate an integration model.", - "tags": ["integration-models"], - "parameters": [], - "operationId": "IntegrationModels.validateIntegrationModel", - "responses": { - "200": { - "description": "The output of the integration model validation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "description": "Message containing either confirmation that the OpenAPI document is valid or validation errors related to the OpenAPI document.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "model": { - "title": "model", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - } - } - }, - "/integrations": { - "post": { - "summary": "Create a new integration.", - "description": "Create a new integration in IAP.", - "tags": ["integrations"], - "parameters": [], - "operationId": "Integrations.createIntegration", - "responses": { - "200": { - "description": "The result of the integration creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "model": { - "$ref": "#/components/schemas/iap_services-schema_model" - }, - "name": { - "$ref": "#/components/schemas/iap_services-schema_name" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "$ref": "#/components/schemas/iap_services-schema_properties" - }, - "virtual": { - "$ref": "#/components/schemas/iap_services-schema_virtual" - } - }, - "required": ["name", "type", "properties", "virtual"] - } - } - } - } - } - } - }, - "get": { - "summary": "Get all integrations.", - "description": "Get all integrations in IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["GitHub"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["GitHub"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["GitHub"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "skipActiveSync", - "in": "query", - "description": "skipActiveSync", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - } - ], - "operationId": "Integrations.getIntegrations", - "responses": { - "200": { - "description": "Contains an array of integrations and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Integrations.admin", "Integrations.apiread"], - "CookieAuth": ["Integrations.admin", "Integrations.apiread"], - "BasicAuth": ["Integrations.admin", "Integrations.apiread"] - } - ], - "deprecated": false - } - }, - "/integrations/{name}": { - "delete": { - "summary": "Delete an integration.", - "description": "Delete an integration from IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.deleteIntegration", - "responses": { - "200": { - "description": "The output of the integration deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a single integration.", - "description": "Get a single integration in IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.getIntegration", - "responses": { - "200": { - "description": "Contains the data of a single integration.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Integrations.admin", "Integrations.apiread"], - "CookieAuth": ["Integrations.admin", "Integrations.apiread"], - "BasicAuth": ["Integrations.admin", "Integrations.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an integration.", - "description": "Update an integration in IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Contains the name for the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.updateIntegration", - "responses": { - "200": { - "description": "The output of the integration update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "$ref": "#/components/schemas/iap_services-schema_properties" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/integrations/{name}/authCode": { - "post": { - "summary": "Posts an access token with an Authorization Code", - "description": "Initiates the Authorization Code exchange for an access token and stores the change", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.postAuthFlowAccessToken", - "responses": { - "200": { - "description": "The success of the operation", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "description": "Some description", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "authorizationCode": { - "title": "authorizationCode", - "type": "string" - }, - "redirectUri": { - "title": "redirectUri", - "type": "string" - } - } - } - } - } - } - } - }, - "/integrations/{name}/properties": { - "put": { - "summary": "Update the properties of an integration.", - "description": "Update the properties of an integration in IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.updateIntegrationProperties", - "responses": { - "200": { - "description": "The output of the integration properties update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties" - } - } - } - } - } - } - } - }, - "/server/config": { - "get": { - "summary": "Get the full IAP configuration.", - "description": "Returns the full IAP configuration, with value/origin definitions for each property.", - "tags": ["server"], - "parameters": [], - "operationId": "Server.getConfig", - "responses": { - "200": { - "description": "The full IAP configuration.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "array", - "items": { - "type": "object", - "required": ["name", "value", "origin"], - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": [ - "null", - "string", - "boolean", - "number", - "object", - "array" - ] - }, - "origin": { - "type": "string" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Server.admin", "Server.apiread"], - "CookieAuth": ["Server.admin", "Server.apiread"], - "BasicAuth": ["Server.admin", "Server.apiread"] - } - ], - "deprecated": false - } - }, - "/server/config/{key}": { - "get": { - "summary": "Get a single IAP configuration property.", - "description": "Returns a single IAP configuration property, with value/origin definitions.", - "tags": ["server"], - "parameters": [ - { - "name": "key", - "in": "path", - "description": "The configuration property key.", - "required": true, - "schema": {} - } - ], - "operationId": "Server.getConfigProperty", - "responses": { - "200": { - "description": "The value and origin of the requested property.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "required": ["name", "value", "origin"], - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": [ - "null", - "string", - "boolean", - "number", - "object", - "array" - ] - }, - "origin": { - "type": "string" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Server.admin", "Server.apiread"], - "CookieAuth": ["Server.admin", "Server.apiread"], - "BasicAuth": ["Server.admin", "Server.apiread"] - } - ], - "deprecated": false - } - }, - "/applications/{name}": { - "get": { - "summary": "Get a single application.", - "description": "Get a single application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.getApplication", - "responses": { - "200": { - "description": "Contains the data of a single application.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Applications.admin", "Applications.apiread"], - "CookieAuth": ["Applications.admin", "Applications.apiread"], - "BasicAuth": ["Applications.admin", "Applications.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an application.", - "description": "Update an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.updateApplication", - "responses": { - "200": { - "description": "The output of the application update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "$ref": "#/components/schemas/iap_services-schema_properties" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/applications/{name}/changelogs": { - "get": { - "summary": "Get the list of changelogs.", - "description": "Get the list of changelogs for a specific application.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - }, - { - "name": "release", - "in": "query", - "description": "release", - "required": false, - "schema": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - } - } - ], - "operationId": "Applications.getApplicationChangelogs", - "responses": { - "200": { - "description": "The list of changelogs available for the requested application.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "string", - "examples": [ - { - "2020.1.1": "Changelog for 2020.1" - } - ], - "pattern": "^[0-9]{4}[.][0-9]{1,}[.][0-9]{1,}$" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Applications.admin", "Applications.apiread"], - "CookieAuth": ["Applications.admin", "Applications.apiread"], - "BasicAuth": ["Applications.admin", "Applications.apiread"] - } - ], - "deprecated": true - } - }, - "/applications": { - "get": { - "summary": "Get all applications.", - "description": "Get all applications in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Applications.getApplications", - "responses": { - "200": { - "description": "Contains an array of applications and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "oneOf": [ - { - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - } - }, - { - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - } - } - } - ] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Applications.admin", "Applications.apiread"], - "CookieAuth": ["Applications.admin", "Applications.apiread"], - "BasicAuth": ["Applications.admin", "Applications.apiread"] - } - ], - "deprecated": false - } - }, - "/applications/{name}/start": { - "put": { - "summary": "Start an application.", - "description": "Start an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.startApplication", - "responses": { - "200": { - "description": "The result of the start process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false - } - }, - "/applications/{name}/stop": { - "put": { - "summary": "Stop an application.", - "description": "Stop an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.stopApplication", - "responses": { - "200": { - "description": "The result of the stop process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false - } - }, - "/applications/{name}/restart": { - "put": { - "summary": "Restart an application.", - "description": "Restart an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.restartApplication", - "responses": { - "200": { - "description": "The result of the restart process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false - } - }, - "/applications/{name}/loglevel": { - "put": { - "summary": "Update the log levels.", - "description": "Update the log levels for an application.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.updateApplicationLogging", - "responses": { - "200": { - "description": "The result of updating the log levels for an application.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "transport": { - "type": "string", - "enum": ["file", "console", "syslog"] - } - }, - "if": { - "properties": { - "transport": { - "const": "syslog" - } - } - }, - "then": { - "properties": { - "level": { - "$ref": "#/components/schemas/iap_services-schema_sys_log_level" - } - } - }, - "else": { - "properties": { - "level": { - "$ref": "#/components/schemas/iap_services-schema_log_level" - } - } - } - } - } - } - } - } - } - } - }, - "/applications/{name}/properties": { - "put": { - "summary": "Update the properties of an application.", - "description": "Update the properties of an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.updateApplicationProperties", - "responses": { - "200": { - "description": "The output of the application properties update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties" - } - } - } - } - } - } - } - }, - "/user/settings": { - "get": { - "summary": "Gets the user settings for the active user", - "description": "Gets the user settings for the active user", - "tags": ["user"], - "parameters": [], - "operationId": "UserSettings.getUserSettings", - "responses": { - "200": { - "description": "The account document for the logged in user.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Updates the user settings for the active user", - "description": "Updates the user settings for the active user", - "tags": ["user"], - "parameters": [], - "operationId": "UserSettings.updateUserSettings", - "responses": { - "200": { - "description": "Updated account document for current user", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "type": "object", - "properties": { - "gitTokens": { - "$ref": "#/components/schemas/iap_accounts-schema_gitTokens" - }, - "email": { - "$ref": "#/components/schemas/iap_accounts-schema_email" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/schema/adapters/{name}": { - "get": { - "summary": "Get the adapter schema.", - "description": "Get the adapter schema.", - "tags": ["schema"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["redis", "email"] - } - } - ], - "operationId": "Schema.getAdapterSchema", - "responses": { - "200": { - "description": "Contains the schema for an adapter.", - "content": { - "application/json": { - "schema": { - "title": "schema", - "type": "object", - "properties": { - "schema": { - "$ref": "#/components/schemas/iap_services-schema" - }, - "decorators": { - "$ref": "#/components/schemas/iap_decorators-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Schema.admin", "Schema.apiread"], - "CookieAuth": ["Schema.admin", "Schema.apiread"], - "BasicAuth": ["Schema.admin", "Schema.apiread"] - } - ], - "deprecated": false - } - }, - "/schema/applications/{name}": { - "get": { - "summary": "Get the application schema.", - "description": "Get the application schema.", - "tags": ["schema"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["redis", "email"] - } - } - ], - "operationId": "Schema.getApplicationSchema", - "responses": { - "200": { - "description": "Contains the schema for an application.", - "content": { - "application/json": { - "schema": { - "title": "schema", - "type": "object", - "properties": { - "schema": { - "$ref": "#/components/schemas/iap_services-schema" - }, - "decorators": { - "$ref": "#/components/schemas/iap_decorators-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Schema.admin", "Schema.apiread"], - "CookieAuth": ["Schema.admin", "Schema.apiread"], - "BasicAuth": ["Schema.admin", "Schema.apiread"] - } - ], - "deprecated": false - } - }, - "/schema/integrations/{name}": { - "get": { - "summary": "Get the integration schema.", - "description": "Get the integration schema.", - "tags": ["schema"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected integration.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["ghv5", "ghv6"] - } - } - ], - "operationId": "Schema.getIntegrationSchema", - "responses": { - "200": { - "description": "Contains the schema for an integration.", - "content": { - "application/json": { - "schema": { - "title": "schema", - "type": "object", - "properties": { - "schema": { - "$ref": "#/components/schemas/iap_services-schema" - }, - "decorators": { - "$ref": "#/components/schemas/iap_decorators-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Schema.admin", "Schema.apiread"], - "CookieAuth": ["Schema.admin", "Schema.apiread"], - "BasicAuth": ["Schema.admin", "Schema.apiread"] - } - ], - "deprecated": false - } - }, - "/schema/profiles": { - "get": { - "summary": "Get the profile schema.", - "description": "Get the profile schema.", - "tags": ["schema"], - "parameters": [], - "operationId": "Schema.getProfileSchema", - "responses": { - "200": { - "description": "Contains the schema for profiles.", - "content": { - "application/json": { - "schema": { - "title": "schema", - "type": "object", - "properties": { - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema" - }, - "decorators": { - "$ref": "#/components/schemas/iap_decorators-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Schema.admin", "Schema.apiread"], - "CookieAuth": ["Schema.admin", "Schema.apiread"], - "BasicAuth": ["Schema.admin", "Schema.apiread"] - } - ], - "deprecated": false - } - }, - "/customization/banner": { - "get": { - "summary": "Get banner.", - "description": "Get banner for customization", - "tags": ["customization"], - "parameters": [], - "operationId": "Customization.getBanner", - "responses": { - "200": { - "description": "The banner object from the database", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/iap_banner-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update the banner.", - "description": "Update the banner", - "tags": ["customization"], - "parameters": [], - "operationId": "Customization.updateBanner", - "responses": { - "200": { - "description": "The result from the database", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Customization.admin"], - "CookieAuth": ["Customization.admin"], - "BasicAuth": ["Customization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_banner-schema" - } - } - } - } - } - }, - "/help/adapters/html": { - "get": { - "summary": "Generate documentation for adapters", - "description": "Generate an HTML documentation page for adapters", - "tags": ["help"], - "parameters": [], - "operationId": "Help.getAdaptersHtml", - "responses": { - "200": { - "description": "HTML string containing documentation for adapter functions.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/help/brokers/html": { - "get": { - "summary": "Generate documentation for brokers", - "description": "Generate an HTML documentation page for brokers", - "tags": ["help"], - "parameters": [], - "operationId": "Help.getBrokersHtml", - "responses": { - "200": { - "description": "HTML string containing documentation for broker functions.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/help/applications/html": { - "get": { - "summary": "Generate documentation for applications", - "description": "Generate an HTML documentation page for applications", - "tags": ["help"], - "parameters": [], - "operationId": "Help.getApplicationsHtml", - "responses": { - "200": { - "description": "HTML string containing documentation for application functions.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/help/openapi": { - "get": { - "summary": "Generate an OpenAPI v3 document for IAP", - "description": "Generate an OpenAPI v3.1.0 document for IAP", - "tags": ["help"], - "parameters": [ - { - "name": "url", - "in": "query", - "description": "url", - "required": false, - "schema": { - "type": "string", - "examples": ["http://localhost:3000"] - } - } - ], - "operationId": "Help.getOpenApi", - "responses": { - "200": { - "description": "An OpenAPI v3 document containing all IAP routes", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/indexes": { - "get": { - "summary": "Get all pre-defined indexes.", - "description": "Get all pre-defined indexes to be used in Mongo.", - "tags": ["indexes"], - "parameters": [ - { - "name": "application", - "in": "query", - "description": "application", - "required": false, - "schema": { - "type": "string", - "examples": ["@itential/app-workflow_engine"] - } - } - ], - "operationId": "Indexes.getIndexes", - "responses": { - "200": { - "description": "Contains an array of pre-defined Mongo indexes.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Indexes.admin", "Indexes.apiread"], - "CookieAuth": ["Indexes.admin", "Indexes.apiread"], - "BasicAuth": ["Indexes.admin", "Indexes.apiread"] - } - ], - "deprecated": false - } - }, - "/indexes/{collection}/status": { - "get": { - "summary": "Check the status of a collection's indexes in Mongo", - "description": "Check the status of pre-defined indexes for a specific collection.", - "tags": ["indexes"], - "parameters": [ - { - "name": "collection", - "in": "path", - "description": "The name of a collection in Mongo.", - "required": true, - "schema": { - "type": "string", - "title": "collection", - "description": "The collection name in the database." - } - } - ], - "operationId": "Indexes.checkIndexes", - "responses": { - "200": { - "description": "The current statuses of the indexes on the specified collection.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "missing": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "misnamed": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "external": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "indexed": { - "type": "integer", - "minimum": 0 - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - }, - "collectionSize": { - "type": "integer" - }, - "inProgress": { - "type": "boolean" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Indexes.admin", "Indexes.apiread"], - "CookieAuth": ["Indexes.admin", "Indexes.apiread"], - "BasicAuth": ["Indexes.admin", "Indexes.apiread"] - } - ], - "deprecated": false - } - }, - "/indexes/status": { - "get": { - "summary": "Check the status of multiple collections' indexes in Mongo", - "description": "Check the status of pre-defined indexes for multiple collections.", - "tags": ["indexes"], - "parameters": [ - { - "name": "collections", - "in": "query", - "description": "collections", - "required": false, - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["accounts", "automations"]] - }, - { - "type": "string", - "examples": ["accounts"] - } - ] - } - } - ], - "operationId": "Indexes.checkMultipleIndexes", - "responses": { - "200": { - "description": "The current statuses of the indexes on the specified collections.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": {}, - "additionalProperties": { - "title": "result", - "type": "object", - "properties": { - "missing": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "misnamed": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "indexed": { - "type": "integer", - "minimum": 0 - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - }, - "collectionSize": { - "type": "integer" - }, - "inProgress": { - "type": "boolean" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Indexes.admin", "Indexes.apiread"], - "CookieAuth": ["Indexes.admin", "Indexes.apiread"], - "BasicAuth": ["Indexes.admin", "Indexes.apiread"] - } - ], - "deprecated": false - } - }, - "/indexes/{collection}": { - "post": { - "summary": "Create a collection's indexes in Mongo", - "description": "Create all pre-defined indexes for a specific collection.", - "tags": ["indexes"], - "parameters": [ - { - "name": "collection", - "in": "path", - "description": "The name of a collection in Mongo.", - "required": true, - "schema": { - "type": "string", - "title": "collection", - "description": "The collection name in the database." - } - } - ], - "operationId": "Indexes.createIndexes", - "responses": { - "200": { - "description": "The current status of the index creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "unchanged": { - "type": "integer", - "minimum": 0 - }, - "changed": { - "type": "integer", - "minimum": 0 - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - }, - "running": { - "type": "boolean" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Indexes.admin"], - "CookieAuth": ["Indexes.admin"], - "BasicAuth": ["Indexes.admin"] - } - ], - "deprecated": false - } - }, - "/authorization/accounts": { - "get": { - "summary": "Get all accounts.", - "description": "Get all accounts", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_accounts-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_accounts-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_accounts-query" - } - }, - { - "name": "inactive", - "in": "query", - "description": "inactive", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema_inactive" - } - }, - { - "name": "isServiceAccount", - "in": "query", - "description": "isServiceAccount", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema_isServiceAccount" - } - }, - { - "name": "groupId", - "in": "query", - "description": "groupId", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "loggedIn", - "in": "query", - "description": "loggedIn", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema_loggedIn" - } - } - ], - "operationId": "Authorization.getAccounts", - "responses": { - "200": { - "description": "The accounts matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_accounts-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - } - }, - "/authorization/accounts/{accountId}": { - "get": { - "summary": "Get an individual account.", - "description": "Get an individual account", - "tags": ["authorization"], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The id for the requested account.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.getAccount", - "responses": { - "200": { - "description": "The individual account document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update an account.", - "description": "Update an account", - "tags": ["authorization"], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The individual account to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.updateAccount", - "responses": { - "200": { - "description": "The output of the account update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "inactive": { - "$ref": "#/components/schemas/iap_accounts-schema_inactive" - }, - "email": { - "$ref": "#/components/schemas/iap_accounts-schema_email" - }, - "assignedRoles": { - "$ref": "#/components/schemas/iap_accounts-schema_assignedRoles" - }, - "memberOf": { - "$ref": "#/components/schemas/iap_accounts-schema_memberOf" - } - } - } - } - } - } - } - } - } - }, - "/authorization/accounts/{accountId}/forceLogout": { - "post": { - "summary": "Force a user to logout and remove their session.", - "description": "Force a user to logout", - "tags": ["authorization"], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The individual account to logout.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.forceLogout", - "responses": { - "200": { - "description": "The output of removing a session", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false - } - }, - "/authorization/groups": { - "get": { - "summary": "Get a list of groups.", - "description": "Get a list of groups", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "inactive", - "in": "query", - "description": "inactive", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_groups-schema_inactive" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "refresh", - "in": "query", - "description": "whether to refresh groups from AAA", - "required": false, - "schema": { - "type": "boolean", - "title": "refresh", - "description": "whether to refresh groups from AAA", - "default": false - } - } - ], - "operationId": "Authorization.getGroups", - "responses": { - "200": { - "description": "The groups matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_groups-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Create a group.", - "description": "Create a group", - "tags": ["authorization"], - "parameters": [], - "operationId": "Authorization.createGroup", - "responses": { - "200": { - "description": "Result of group creation process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_groups-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "$ref": "#/components/schemas/iap_groups-schema" - } - } - } - } - } - } - } - }, - "/authorization/groups/list": { - "get": { - "summary": "Get a simplified list of groups.", - "description": "Get a simplified list of groups", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "inactive", - "in": "query", - "description": "inactive", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_groups-schema_inactive" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "refresh", - "in": "query", - "description": "whether to refresh groups from AAA", - "required": false, - "schema": { - "type": "boolean", - "title": "refresh", - "description": "whether to refresh groups from AAA", - "default": false - } - } - ], - "operationId": "Authorization.getGroupsShortList", - "responses": { - "200": { - "description": "The groups matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "$ref": "#/components/schemas/iap_groups-schema_provenance" - }, - "name": { - "$ref": "#/components/schemas/iap_groups-schema_name" - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/authorization/groups/{groupId}": { - "get": { - "summary": "Get an individual group.", - "description": "Get an individual group", - "tags": ["authorization"], - "parameters": [ - { - "name": "groupId", - "in": "path", - "description": "The id for the requested group.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.getGroup", - "responses": { - "200": { - "description": "The individual group document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_groups-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update a group.", - "description": "Update a group", - "tags": ["authorization"], - "parameters": [ - { - "name": "groupId", - "in": "path", - "description": "The individual group to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.updateGroup", - "responses": { - "200": { - "description": "The output of the group update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_groups-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/iap_groups-schema_description" - }, - "inactive": { - "$ref": "#/components/schemas/iap_groups-schema_inactive" - }, - "memberOf": { - "$ref": "#/components/schemas/iap_groups-schema_memberOf" - }, - "assignedRoles": { - "$ref": "#/components/schemas/iap_groups-schema_assignedRoles" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a group.", - "description": "Delete a group", - "tags": ["authorization"], - "parameters": [ - { - "name": "groupId", - "in": "path", - "description": "The individual group to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.deleteGroup", - "responses": { - "200": { - "description": "Result of group deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false - } - }, - "/authorization/roles": { - "get": { - "summary": "Get a list of roles.", - "description": "Get a list of roles", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roles-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roles-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roles-query" - } - }, - { - "name": "inactive", - "in": "query", - "description": "inactive", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Authorization.getRoles", - "responses": { - "200": { - "description": "The roles matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_roles-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Create a role.", - "description": "Create a role", - "tags": ["authorization"], - "parameters": [], - "operationId": "Authorization.createRole", - "responses": { - "200": { - "description": "Result of role creation process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_roles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/iap_roles-schema" - } - } - } - } - } - } - } - }, - "/authorization/roles/{roleId}": { - "get": { - "summary": "Get an individual role.", - "description": "Get an individual role", - "tags": ["authorization"], - "parameters": [ - { - "name": "roleId", - "in": "path", - "description": "The id for the requested role.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roleId" - } - } - ], - "operationId": "Authorization.getRole", - "responses": { - "200": { - "description": "The individual role document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_roles-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update a role.", - "description": "Update a role", - "tags": ["authorization"], - "parameters": [ - { - "name": "roleId", - "in": "path", - "description": "The individual role to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roleId" - } - } - ], - "operationId": "Authorization.updateRole", - "responses": { - "200": { - "description": "The output of the role update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_roles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/iap_roles-schema_description" - }, - "allowedMethods": { - "$ref": "#/components/schemas/iap_roles-schema_allowedMethods" - }, - "allowedViews": { - "$ref": "#/components/schemas/iap_roles-schema_allowedViews" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a role.", - "description": "Delete a role", - "tags": ["authorization"], - "parameters": [ - { - "name": "roleId", - "in": "path", - "description": "The individual role to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roleId" - } - } - ], - "operationId": "Authorization.deleteRole", - "responses": { - "200": { - "description": "Result of role deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false - } - }, - "/authorization/methods": { - "get": { - "summary": "Get a list of methods.", - "description": "Get a list of methods in IAP.", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_methods-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_methods-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_methods-query" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Authorization.getMethods", - "responses": { - "200": { - "description": "List of methods in IAP.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["getRoles"] - }, - "provenance": { - "type": "string", - "examples": ["Authorization"] - }, - "route": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/roles"] - }, - "verb": { - "type": "string", - "examples": ["GET"] - }, - "fullPath": { - "type": "string", - "examples": ["/authorization/roles"] - } - } - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - } - }, - "/authorization/views": { - "get": { - "summary": "Get a list of views.", - "description": "Get a list of views in IAP.", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_views-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_views-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_views-query" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Authorization.getViews", - "responses": { - "200": { - "description": "List of views in IAP.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/"] - }, - "provenance": { - "type": "string", - "examples": ["WorkFlowEngine"] - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - } - }, - "/authorization/csv/export": { - "get": { - "summary": "Extract CSV data of accounts, groups, and roles", - "description": "Retrieve CSV data of accounts, groups, and roles information", - "tags": ["authorization"], - "parameters": [], - "operationId": "Authorization.exportAuthReport", - "responses": { - "200": { - "description": "Result of export", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - } - }, - "/device-counts": { - "get": { - "summary": "Get device count history", - "description": "Get device count history", - "tags": ["device-counts"], - "parameters": [ - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "type": "string", - "enum": ["newest", "oldest"], - "default": "newest" - } - }, - { - "name": "serverId", - "in": "query", - "description": "The server ID where the device counts came from", - "required": false, - "schema": { - "type": "string", - "description": "The server ID where the device counts came from" - } - }, - { - "name": "before", - "in": "query", - "description": "The timestamp in milliseconds used as an upper range. Should be higher than the after value.", - "required": false, - "schema": { - "type": "integer", - "description": "The timestamp in milliseconds used as an upper range. Should be higher than the after value." - } - }, - { - "name": "after", - "in": "query", - "description": "The timestamp in milliseconds used as a lower range. Should be lower than the after value.", - "required": false, - "schema": { - "type": "integer", - "description": "The timestamp in milliseconds used as a lower range. Should be lower than the after value." - } - } - ], - "operationId": "DeviceCounts.getDeviceCounts", - "responses": { - "200": { - "description": "The device counts matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_device-count-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["DeviceCounts.admin"], - "CookieAuth": ["DeviceCounts.admin"], - "BasicAuth": ["DeviceCounts.admin"] - } - ], - "deprecated": false - } - }, - "/device-counts/refresh": { - "post": { - "summary": "Refresh device count history", - "description": "Refresh device count history", - "tags": ["device-counts"], - "parameters": [], - "operationId": "DeviceCounts.createDeviceCount", - "responses": { - "200": { - "description": "Refresh device count history", - "content": { - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["DeviceCounts.admin"], - "CookieAuth": ["DeviceCounts.admin"], - "BasicAuth": ["DeviceCounts.admin"] - } - ], - "deprecated": false - } - }, - "/health/adapters/{name}": { - "get": { - "summary": "Get the health of a single adapter.", - "description": "Get the health of a single adapter in IAP.", - "tags": ["health"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Health.getAdapterHealth", - "responses": { - "200": { - "description": "Contains the selected adapters health data.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_services-health-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/applications/{name}": { - "get": { - "summary": "Get the health of a single application.", - "description": "Get the health of a single application in IAP.", - "tags": ["health"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Health.getApplicationHealth", - "responses": { - "200": { - "description": "Contains the selected applications health data.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_services-health-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/adapters": { - "get": { - "summary": "Get the health of all the adapters.", - "description": "Get the health of all the adapters in IAP.", - "tags": ["health"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Health.getAdaptersHealth", - "responses": { - "200": { - "description": "Contains the adapters health data.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_services-health-schema" - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/applications": { - "get": { - "summary": "Get the health of all the applications.", - "description": "Get the health of all the applications in IAP.", - "tags": ["health"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Health.getApplicationsHealth", - "responses": { - "200": { - "description": "Contains the applications health data.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_services-health-schema" - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/server": { - "get": { - "summary": "Get the health of the server.", - "description": "Get the health of the server.", - "tags": ["health"], - "parameters": [], - "operationId": "Health.getServerHealth", - "responses": { - "200": { - "description": "Contains the server health data.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "version": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "release": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "arch": { - "type": "string", - "enum": [ - "arm", - "arm64", - "ia32", - "mips", - "mipsel", - "ppc", - "ppc64", - "s390", - "s390x", - "x32", - "x64" - ] - }, - "platform": { - "type": "string", - "enum": [ - "aix", - "darwin", - "freebsd", - "linux", - "openbsd", - "sunos", - "win32" - ] - }, - "versions": { - "type": "object", - "properties": { - "node": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "v8": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "uv": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "zlib": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "brotli": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "ares": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "modules": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "nghttp2": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "napi": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "llhttp": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "http_parser": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "openssl": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "cldr": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "icu": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "tz": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "unicode": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - } - } - }, - "memoryUsage": { - "$ref": "#/components/schemas/iap_services-health-schema_memoryUsage" - }, - "cpuUsage": { - "$ref": "#/components/schemas/iap_services-health-schema_cpuUsage" - }, - "uptime": { - "$ref": "#/components/schemas/iap_services-health-schema_uptime" - }, - "pid": { - "$ref": "#/components/schemas/iap_services-health-schema_pid" - }, - "dependencies": { - "type": "object", - "properties": { - "@itential/logger": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "@itential/database": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "@itential/itential-utils": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/system": { - "get": { - "summary": "Get the health of the system.", - "description": "Get the health of the system.", - "tags": ["health"], - "parameters": [], - "operationId": "Health.getSystemHealth", - "responses": { - "200": { - "description": "Contains the system health data.", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "results", - "properties": { - "arch": { - "type": "string", - "examples": ["x64"] - }, - "release": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "uptime": { - "type": "integer", - "examples": [12539] - }, - "freemem": { - "type": "integer", - "examples": [14377422848] - }, - "totalmem": { - "type": "integer", - "examples": [34359738368] - }, - "loadavg": { - "type": "array", - "items": { - "type": "number", - "examples": [3.0166015625, 1.74169921875] - } - }, - "cpus": { - "type": "array", - "items": { - "type": "object", - "required": ["model", "speed", "times"], - "properties": { - "model": { - "type": "string", - "examples": [ - "Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz" - ] - }, - "speed": { - "type": "integer", - "examples": [2300] - }, - "times": { - "type": "object", - "required": ["user", "nice", "sys", "idle", "irq"], - "properties": { - "user": { - "type": "integer", - "examples": [604790] - }, - "nice": { - "type": "integer", - "examples": [0] - }, - "sys": { - "type": "integer", - "examples": [322560] - }, - "idle": { - "type": "integer", - "examples": [6071010] - }, - "irq": { - "type": "integer", - "examples": [0] - } - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/status": { - "get": { - "summary": "Get status.", - "description": "Get status of current IAP.", - "tags": ["health"], - "parameters": [], - "operationId": "Health.getHealthStatus", - "responses": { - "200": { - "description": "status of the current IAP.", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "serverId": { - "type": "string" - }, - "services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "service": { - "type": "string" - }, - "status": { - "type": "string", - "enum": ["running", "failed"] - } - } - } - }, - "timestamp": { - "type": "integer" - }, - "apps": { - "type": "string", - "enum": ["running", "degraded"] - }, - "adapters": { - "type": "string", - "enum": ["running", "degraded"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/prebuilts/{id}/export": { - "get": { - "summary": "Export a prebuilt", - "description": "Export a prebuilt from IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The object id of the selected prebuilt.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Prebuilts.exportPrebuilt", - "responses": { - "200": { - "description": "The data for a prebuilt.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] - } - ], - "deprecated": false - } - }, - "/prebuilts/{id}": { - "get": { - "summary": "Get a single prebuilt.", - "description": "Get a single prebuilt in IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The object id of the selected prebuilt.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Prebuilts.getPrebuilt", - "responses": { - "200": { - "description": "The data for a prebuilt.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Remove a prebuilt.", - "description": "Remove a prebuilt from IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The object id of the selected prebuilt.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Prebuilts.removePrebuilt", - "responses": { - "200": { - "description": "The output of the prebuilt removal process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Prebuilts.admin"], - "CookieAuth": ["Prebuilts.admin"], - "BasicAuth": ["Prebuilts.admin"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update a prebuilt", - "description": "Update a prebuilt in IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The object id of the selected prebuilt.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Prebuilts.updatePrebuilt", - "responses": { - "200": { - "description": "The output of the prebuilt update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Prebuilts.admin"], - "CookieAuth": ["Prebuilts.admin"], - "BasicAuth": ["Prebuilts.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "prebuilt": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - } - } - } - } - }, - "/prebuilts": { - "get": { - "summary": "Get all the prebuilts.", - "description": "Get all the prebuilts in IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["nso"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["artifact-wizard"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["n", "a"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "config", - "in": "query", - "description": "config", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_config" - } - } - ], - "operationId": "Prebuilts.getPrebuilts", - "responses": { - "200": { - "description": "Contains an array of prebuilts and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "required": ["packages", "total"], - "properties": { - "packages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] - } - ], - "deprecated": false - } - }, - "/prebuilts/import": { - "post": { - "summary": "Import a prebuilt.", - "description": "Import a prebuilt into IAP.", - "tags": ["prebuilts"], - "parameters": [], - "operationId": "Prebuilts.importPrebuilt", - "responses": { - "200": { - "description": "The output of the prebuilt import process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Prebuilts.admin"], - "CookieAuth": ["Prebuilts.admin"], - "BasicAuth": ["Prebuilts.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "prebuilt": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "overwrite": { - "type": "boolean", - "description": "If the import functionality should overwrite existing components", - "examples": [true, false] - } - } - } - } - } - } - } - } - } - }, - "/prebuilts/import/validation": { - "put": { - "summary": "Validate the data structure of a prebuilt.", - "description": "Validate the data structure of a prebuilt in IAP.", - "tags": ["prebuilts"], - "parameters": [], - "operationId": "Prebuilts.validatePrebuilt", - "responses": { - "200": { - "description": "The output of the prebuilt update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Prebuilts.admin"], - "CookieAuth": ["Prebuilts.admin"], - "BasicAuth": ["Prebuilts.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "prebuilt": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - } - } - } - } - }, - "/external-links": { - "get": { - "summary": "Get all links.", - "description": "Get all links", - "tags": ["external-links"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_links-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_links-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_links-query" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "ExternalLinks.getLinks", - "responses": { - "200": { - "description": "The links matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_links-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], - "CookieAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], - "BasicAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Update a link.", - "description": "Create a link", - "tags": ["external-links"], - "parameters": [], - "operationId": "ExternalLinks.createLink", - "responses": { - "200": { - "description": "Result of link creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_links-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["ExternalLinks.admin"], - "CookieAuth": ["ExternalLinks.admin"], - "BasicAuth": ["ExternalLinks.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "link": { - "$ref": "#/components/schemas/iap_links-schema" - } - } - } - } - } - } - } - }, - "/external-links/{linkId}": { - "get": { - "summary": "Get an individual link.", - "description": "Get an individual link", - "tags": ["external-links"], - "parameters": [ - { - "name": "linkId", - "in": "path", - "description": "The id for the requested link.", - "required": true, - "schema": { - "title": "linkId", - "type": "string" - } - } - ], - "operationId": "ExternalLinks.getLink", - "responses": { - "200": { - "description": "The individual link document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_links-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], - "CookieAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], - "BasicAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update a link.", - "description": "Update a link", - "tags": ["external-links"], - "parameters": [ - { - "name": "linkId", - "in": "path", - "description": "The individual link to update.", - "required": true, - "schema": { - "title": "linkId", - "type": "string" - } - } - ], - "operationId": "ExternalLinks.updateLink", - "responses": { - "200": { - "description": "The output of the link update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_links-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["ExternalLinks.admin"], - "CookieAuth": ["ExternalLinks.admin"], - "BasicAuth": ["ExternalLinks.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_links-schema_name" - }, - "address": { - "$ref": "#/components/schemas/iap_links-schema_address" - }, - "description": { - "$ref": "#/components/schemas/iap_links-schema_description" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a link.", - "description": "Delete a link", - "tags": ["external-links"], - "parameters": [ - { - "name": "linkId", - "in": "path", - "description": "The individual link to delete.", - "required": true, - "schema": { - "title": "linkId", - "type": "string" - } - } - ], - "operationId": "ExternalLinks.deleteLink", - "responses": { - "200": { - "description": "Result of link deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["ExternalLinks.admin"], - "CookieAuth": ["ExternalLinks.admin"], - "BasicAuth": ["ExternalLinks.admin"] - } - ], - "deprecated": false - } - }, - "/prebuilts-repository/configs": { - "post": { - "summary": "Create repository configuration", - "description": "Create a new repository configuration", - "tags": ["prebuilts-repository"], - "parameters": [], - "operationId": "PrebuiltsRepository.createRepositoryConfig", - "responses": { - "200": { - "description": "The result of the creation process", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_repository-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "config": { - "$ref": "#/components/schemas/iap_repository-schema" - } - } - } - } - } - } - }, - "get": { - "summary": "Get Repository Configurations", - "description": "Get all the Prebuilt Repository configurations", - "tags": ["prebuilts-repository"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "PrebuiltsRepository.getRepositoryConfigs", - "responses": { - "200": { - "description": "Contains an array of prebuilts and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "required": ["results", "total"], - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_prebuilts-schema_name" - }, - "enabled": { - "$ref": "#/components/schemas/iap_repository-schema_enabled" - }, - "type": { - "$ref": "#/components/schemas/iap_repository-schema_type" - }, - "hostname": { - "$ref": "#/components/schemas/iap_repository-schema_hostname" - }, - "path": { - "$ref": "#/components/schemas/iap_repository-schema_path" - }, - "credentials": { - "$ref": "#/components/schemas/iap_repository-schema_credentials" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false - } - }, - "/prebuilts-repository/configs/{name}": { - "delete": { - "summary": "Delete repository configuration", - "description": "Delete an existing repository configuration", - "tags": ["prebuilts-repository"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the repository configuration", - "required": true, - "schema": { - "title": "name", - "type": "string" - } - } - ], - "operationId": "PrebuiltsRepository.deleteRepositoryConfig", - "responses": { - "200": { - "description": "The result of the delete process", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update repository configuration", - "description": "Update an existing repository configuration", - "tags": ["prebuilts-repository"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the repository configuration", - "required": true, - "schema": { - "title": "name", - "type": "string" - } - } - ], - "operationId": "PrebuiltsRepository.updateRepositoryConfig", - "responses": { - "200": { - "description": "The result of the update process", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_repository-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "A flag that denotes if the repository configuration is connected" - }, - "type": { - "type": "string", - "description": "The type of Repository", - "enum": ["gitlab"] - }, - "hostname": { - "type": "string", - "description": "The hostname of the Respository endpoint", - "examples": ["gitlab.com"] - }, - "path": { - "type": "string", - "description": "The path of the Repository endpoint", - "examples": ["itentialopensource/pre-built-automations"] - }, - "credentials": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "An access token used to make HTTP requests", - "examples": ["uTc_P4pnMAEsLbQHmyOt"] - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - } - } - }, - "/prebuilts-repository": { - "get": { - "summary": "Get all prebuilts", - "description": "Get all prebuilts from a repository.", - "tags": ["prebuilts-repository"], - "parameters": [ - { - "name": "page", - "in": "query", - "description": "The page number for the request return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "The page number for the request return. Used for pagination.", - "default": 1, - "minimum": 1, - "examples": [1, 3, 5] - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "iap_version", - "in": "query", - "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.", - "required": false, - "schema": { - "type": "number", - "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.", - "examples": [2019.3, 2020.1] - } - }, - { - "name": "search", - "in": "query", - "description": "Search all available artifacts to find a match related to the provided query.", - "required": false, - "schema": { - "type": "string", - "description": "Search all available artifacts to find a match related to the provided query.", - "examples": ["device", "nso"] - } - }, - { - "name": "config", - "in": "query", - "description": "config", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_config" - } - }, - { - "name": "versionStatus", - "in": "query", - "description": "Filter the list of Pre-builts based on the available version of the Pre-built in comparison to the current version of IAP", - "required": false, - "schema": { - "type": "string", - "description": "Filter the list of Pre-builts based on the available version of the Pre-built in comparison to the current version of IAP", - "enum": ["latest", "current"] - } - } - ], - "operationId": "PrebuiltsRepository.getRepositoryPrebuilts", - "responses": { - "200": { - "description": "Contains an array of prebuilts and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "required": ["results", "total"], - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "versionStatus": { - "type": "object", - "properties": { - "status": { - "type": "string", - "examples": ["current"] - }, - "iap_version": { - "type": "string", - "examples": ["release/2020.1"] - } - } - }, - "installStatus": { - "type": "object", - "properties": { - "installable": { - "type": "boolean", - "enum": [true, false] - }, - "missingDependencies": { - "oneOf": [ - { - "type": "object", - "description": "A list of every dependency in the prebuilt that is missing from the running system." - }, - { - "type": "null" - } - ] - }, - "mismatchingDependencies": { - "oneOf": [ - { - "type": "object", - "description": "A list of every dependency in the prebuilt that has a version greater than the version of the service running on the system." - }, - { - "type": "null" - } - ] - } - } - }, - "availableUpdate": { - "oneOf": [ - { - "type": "boolean", - "enum": [true, false] - }, - { - "type": "null" - } - ] - }, - "name": { - "$ref": "#/components/schemas/iap_prebuilts-schema_name" - }, - "version": { - "$ref": "#/components/schemas/iap_prebuilts-schema_version" - }, - "description": { - "$ref": "#/components/schemas/iap_prebuilts-schema_description" - }, - "author": { - "$ref": "#/components/schemas/iap_prebuilts-schema_author" - }, - "published": { - "type": "string", - "examples": ["2020-04-09T17:44:30.215Z"], - "format": "date-time" - }, - "repository": { - "$ref": "#/components/schemas/iap_prebuilts-schema_repository" - }, - "license": { - "$ref": "#/components/schemas/iap_prebuilts-schema_license" - }, - "keywords": { - "$ref": "#/components/schemas/iap_prebuilts-schema_keywords" - }, - "IAPDependencies": { - "$ref": "#/components/schemas/iap_prebuilts-schema_IAPDependencies" - }, - "readme": { - "$ref": "#/components/schemas/iap_prebuilts-schema_readme" - }, - "download": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - }, - "page": { - "type": "integer" - }, - "total-pages": { - "type": "integer" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false - } - }, - "/sso/configs": { - "post": { - "summary": "Create an SSO configuration", - "description": "Create an SSO configuration", - "tags": ["sso"], - "parameters": [], - "operationId": "SSO.createSSOConfig", - "responses": { - "200": { - "description": "The result of the SSO config creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSO.admin"], - "CookieAuth": ["SSO.admin"], - "BasicAuth": ["SSO.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "config": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - } - } - } - }, - "get": { - "summary": "Get all SSO configurations", - "description": "Get all SSO configurations", - "tags": ["sso"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["GitHub"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "enum": [ - "name", - "samlEmailAttribute", - "samlUserNameAttribute", - "samlGroupsAttribute", - "samlFirstNameAttribute", - "ssoType" - ] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["Okta"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "enum": [ - "name", - "samlEmailAttribute", - "samlUserNameAttribute", - "samlGroupsAttribute", - "samlFirstNameAttribute", - "ssoType" - ] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["Okta"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "enum": [ - "name", - "samlEmailAttribute", - "samlUserNameAttribute", - "samlGroupsAttribute", - "samlFirstNameAttribute", - "ssoType" - ] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "SSO.getSSOConfigs", - "responses": { - "200": { - "description": "Contains an array of SSO configurations and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_sso-schema" - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSO.admin", "SSO.apiread"], - "CookieAuth": ["SSO.admin", "SSO.apiread"], - "BasicAuth": ["SSO.admin", "SSO.apiread"] - } - ], - "deprecated": false - } - }, - "/sso/configs/{name}": { - "delete": { - "summary": "Delete an SSO configuration", - "description": "Delete an SSO configuration", - "tags": ["sso"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration to delete", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "SSO.deleteSSOConfig", - "responses": { - "200": { - "description": "The result of the SSO config deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSO.admin"], - "CookieAuth": ["SSO.admin"], - "BasicAuth": ["SSO.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a single SSO configuration", - "description": "Get a single SSO configuration", - "tags": ["sso"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration to get", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "SSO.getSSOConfig", - "responses": { - "200": { - "description": "The SSO configuration document", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSO.admin", "SSO.apiread"], - "CookieAuth": ["SSO.admin", "SSO.apiread"], - "BasicAuth": ["SSO.admin", "SSO.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an SSO configuration", - "description": "Update an SSO configuration", - "tags": ["sso"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration to delete", - "required": true, - "schema": { - "title": "result", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "SSO.updateSSOConfig", - "responses": { - "200": { - "description": "The result of the SSO config update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSO.admin"], - "CookieAuth": ["SSO.admin"], - "BasicAuth": ["SSO.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "config": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - } - } - } - } - }, - "/sso/configs/{name}/active": { - "post": { - "summary": "Activate an SSO configuration", - "description": "Activate an SSO configuration", - "tags": ["sso"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration to delete", - "required": true, - "schema": { - "title": "result", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "SSO.setSSOConfigActive", - "responses": { - "200": { - "description": "The result of the SSO config update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSO.admin"], - "CookieAuth": ["SSO.admin"], - "BasicAuth": ["SSO.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "active": { - "title": "active", - "type": "boolean" - } - } - } - } - } - } - } - }, - "/prometheus_metrics": { - "get": { - "summary": "Get prometheus metrics.", - "description": "Builds and returns all prometheus metrics.", - "tags": ["prometheus_metrics"], - "parameters": [], - "operationId": "PrometheusMetrics.getPrometheusMetrics", - "responses": { - "200": { - "description": "result", - "content": { - "application/json": { - "schema": { - "title": "result", - "description": "Metrics to be ingested by prometheus.", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/group-mappings": { - "get": { - "summary": "Get all group mappings.", - "description": "Get all group mappings", - "tags": ["group-mappings"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "expand", - "in": "query", - "description": "Sets the fields to expand", - "required": false, - "schema": { - "type": "string", - "title": "List of fields to get expanded data", - "description": "Sets the fields to expand", - "examples": ["iapGroups"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "SSOGroupMappings.getGroupMappings", - "responses": { - "200": { - "description": "The group mappings matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_mapping-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"], - "CookieAuth": [ - "SSOGroupMappings.admin", - "SSOGroupMappings.apiread" - ], - "BasicAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Create a group mapping.", - "description": "Create a group mapping", - "tags": ["group-mappings"], - "parameters": [], - "operationId": "SSOGroupMappings.createGroupMapping", - "responses": { - "200": { - "description": "Result of group mapping creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_mapping-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSOGroupMappings.admin"], - "CookieAuth": ["SSOGroupMappings.admin"], - "BasicAuth": ["SSOGroupMappings.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupMapping": { - "$ref": "#/components/schemas/iap_mapping-schema" - } - } - } - } - } - } - } - }, - "/group-mappings/{provenance}/{externalGroup}": { - "get": { - "summary": "Get an individual group mapping.", - "description": "Get an individual group mapping", - "tags": ["group-mappings"], - "parameters": [ - { - "name": "provenance", - "in": "path", - "description": "The provenance for the requested group mapping.", - "required": true, - "schema": { - "title": "provenance", - "type": "string" - } - }, - { - "name": "externalGroup", - "in": "path", - "description": "The name of the external group that is mapped.", - "required": true, - "schema": { - "title": "externalGroup", - "type": "string" - } - } - ], - "operationId": "SSOGroupMappings.getGroupMapping", - "responses": { - "200": { - "description": "The individual group mapping document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_mapping-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"], - "CookieAuth": [ - "SSOGroupMappings.admin", - "SSOGroupMappings.apiread" - ], - "BasicAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update a group mapping.", - "description": "Update a group mapping", - "tags": ["group-mappings"], - "parameters": [ - { - "name": "provenance", - "in": "path", - "description": "The provenance for the requested group mapping.", - "required": true, - "schema": { - "title": "provenance", - "type": "string" - } - }, - { - "name": "externalGroup", - "in": "path", - "description": "The individual group mapping to update.", - "required": true, - "schema": { - "title": "externalGroup", - "type": "string" - } - } - ], - "operationId": "SSOGroupMappings.updateGroupMapping", - "responses": { - "200": { - "description": "The output of the group mapping update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_mapping-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSOGroupMappings.admin"], - "CookieAuth": ["SSOGroupMappings.admin"], - "BasicAuth": ["SSOGroupMappings.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "iapGroups": { - "$ref": "#/components/schemas/iap_mapping-schema_iapGroups" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a group mapping.", - "description": "Delete a group mapping", - "tags": ["group-mappings"], - "parameters": [ - { - "name": "provenance", - "in": "path", - "description": "The provenance for the requested group mapping.", - "required": true, - "schema": { - "title": "provenance", - "type": "string" - } - }, - { - "name": "externalGroup", - "in": "path", - "description": "The individual group mapping to delete.", - "required": true, - "schema": { - "title": "externalGroup", - "type": "string" - } - } - ], - "operationId": "SSOGroupMappings.deleteGroupMapping", - "responses": { - "200": { - "description": "Result of group mapping deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["SSOGroupMappings.admin"], - "CookieAuth": ["SSOGroupMappings.admin"], - "BasicAuth": ["SSOGroupMappings.admin"] - } - ], - "deprecated": false - } - }, - "/git/{gitType}/repos/{repoPath}/branches/{branchName}/projects/{projectPath}": { - "get": { - "summary": "Retrieve a project from Git", - "description": "Retrieve a project from Git", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - }, - { - "name": "branchName", - "in": "path", - "description": "The name of the branch that is used.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_branchName" - } - }, - { - "name": "projectPath", - "in": "path", - "description": "The file path within a Git repository to a project file", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_projectPath" - } - } - ], - "operationId": "Git.getProject", - "responses": { - "200": { - "description": "The exact contents of the project file stored in Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - }, - "post": { - "summary": "Initialize a project in Git", - "description": "Initialize a project in Git", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - }, - { - "name": "branchName", - "in": "path", - "description": "The name of the branch that is used.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_branchName" - } - }, - { - "name": "projectPath", - "in": "path", - "description": "The file path within a Git repository to a project file", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_projectPath" - } - }, - { - "name": "project", - "in": "path", - "description": "The project document being pushed to Git", - "required": true, - "schema": { - "title": "project", - "type": "object" - } - } - ], - "operationId": "Git.initProject", - "responses": { - "200": { - "description": "The result of initializing a project in Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully initialized project"] - }, - "data": { - "type": "object", - "description": "The project document pushed to Git" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "commitMessage": { - "$ref": "#/components/schemas/iap_git-common_commitMessage" - } - } - } - } - } - } - }, - "put": { - "summary": "Update a project in Git", - "description": "Update a project in Git", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - }, - { - "name": "branchName", - "in": "path", - "description": "The name of the branch that is used.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_branchName" - } - }, - { - "name": "projectPath", - "in": "path", - "description": "The file path within a Git repository to a project file", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_projectPath" - } - }, - { - "name": "project", - "in": "path", - "description": "The project document being pushed to Git", - "required": true, - "schema": { - "title": "project", - "type": "object" - } - } - ], - "operationId": "Git.updateProject", - "responses": { - "200": { - "description": "The result of updating a project in Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully updated project"] - }, - "data": { - "type": "object", - "description": "The project document pushed to Git" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "commitMessage": { - "$ref": "#/components/schemas/iap_git-common_commitMessage" - } - } - } - } - } - } - } - }, - "/git/{gitType}/repos/{repoPath}/branches": { - "post": { - "summary": "Create a new branch in a repository", - "description": "Create a new branch in a repository", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - } - ], - "operationId": "Git.createBranch", - "responses": { - "200": { - "description": "The result of creating a branch", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully created branch: exampleBranch"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "originBranch": { - "$ref": "#/components/schemas/iap_git-common_branchName" - }, - "newBranch": { - "$ref": "#/components/schemas/iap_git-common_branchName" - } - } - } - } - } - } - }, - "get": { - "summary": "List the available branches for a repository", - "description": "List the available branches for a repository", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - } - ], - "operationId": "Git.listBranches", - "responses": { - "200": { - "description": "The result of retrieving a list of branches from Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the branch", - "type": "string", - "examples": ["main"] - }, - "protected": { - "description": "Whether or not the branch is protected", - "type": "boolean" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false - } - }, - "/git/{gitType}/repos/{repoPath}": { - "post": { - "summary": "Create a new repository in Git for storing projects", - "description": "Create a new repository in Git for storing projects", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - } - ], - "operationId": "Git.createRepo", - "responses": { - "200": { - "description": "The result of creating a repository in Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": [ - "`Successfully created repository: ExampleRepo" - ] - }, - "data": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The full path to the repository in Git", - "examples": [ - "group1/group2/ExampleRepo", - "exampleOrg/ExampleRepo" - ] - }, - "default_branch": { - "type": "string", - "description": "The default branch created for the repository", - "examples": ["main"] - }, - "visibility": { - "type": "string", - "description": "The visibility of the repository", - "examples": ["private"] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repoName": { - "title": "repoName", - "type": "string", - "examples": ["RepositoryName"] - } - } - } - } - } - } - } - }, - "/profiles": { - "post": { - "summary": "Creates a new profile", - "description": "Create a new profile in IAP.", - "tags": ["profiles"], - "parameters": [], - "operationId": "Profiles.createProfile", - "responses": { - "200": { - "description": "The output of the profile creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "uiProps": { - "$ref": "#/components/schemas/iap_profiles-schema_uiProps" - }, - "authenticationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" - }, - "expressProps": { - "$ref": "#/components/schemas/iap_profiles-schema_expressProps" - }, - "loggerProps": { - "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" - }, - "redisProps": { - "$ref": "#/components/schemas/iap_profiles-schema_redisProps" - }, - "auditProps": { - "$ref": "#/components/schemas/iap_profiles-schema_auditProps" - }, - "pathProps": { - "$ref": "#/components/schemas/iap_profiles-schema_pathProps" - }, - "alarmProps": { - "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" - }, - "id": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - }, - "services": { - "$ref": "#/components/schemas/iap_profiles-schema_services" - }, - "description": { - "$ref": "#/components/schemas/iap_profiles-schema_description" - }, - "adapterStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" - }, - "systemProps": { - "$ref": "#/components/schemas/iap_profiles-schema_systemProps" - }, - "integrationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" - }, - "retryStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" - }, - "serviceDirectory": { - "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" - } - }, - "required": ["id"] - } - } - } - } - } - } - }, - "get": { - "summary": "Get all profiles.", - "description": "Get all the profiles in IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["profile1"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["id"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["profile1"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["id"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["profile"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["id"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Profiles.getProfiles", - "responses": { - "200": { - "description": "Contains the data of a profile.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - } - }, - "profile": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Profiles.admin", "Profiles.apiread"], - "CookieAuth": ["Profiles.admin", "Profiles.apiread"], - "BasicAuth": ["Profiles.admin", "Profiles.apiread"] - } - ], - "deprecated": false - } - }, - "/profiles/import": { - "post": { - "summary": "Import a new profile", - "description": "Import a new profile in IAP.", - "tags": ["profiles"], - "parameters": [], - "operationId": "Profiles.importProfile", - "responses": { - "200": { - "description": "The output of the profile import process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "uiProps": { - "$ref": "#/components/schemas/iap_profiles-schema_uiProps" - }, - "authenticationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" - }, - "expressProps": { - "$ref": "#/components/schemas/iap_profiles-schema_expressProps" - }, - "loggerProps": { - "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" - }, - "redisProps": { - "$ref": "#/components/schemas/iap_profiles-schema_redisProps" - }, - "auditProps": { - "$ref": "#/components/schemas/iap_profiles-schema_auditProps" - }, - "pathProps": { - "$ref": "#/components/schemas/iap_profiles-schema_pathProps" - }, - "alarmProps": { - "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" - }, - "id": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - }, - "services": { - "$ref": "#/components/schemas/iap_profiles-schema_services" - }, - "description": { - "$ref": "#/components/schemas/iap_profiles-schema_description" - }, - "adapterStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" - }, - "systemProps": { - "$ref": "#/components/schemas/iap_profiles-schema_systemProps" - }, - "integrationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" - }, - "retryStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" - }, - "serviceDirectory": { - "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" - }, - "migrationVersion": { - "type": "integer", - "minimum": 0 - } - }, - "required": ["id"] - } - } - } - } - } - } - } - }, - "/profiles/{id}": { - "delete": { - "summary": "Delete a profile.", - "description": "Delete a profile from IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.deleteProfile", - "responses": { - "200": { - "description": "The output of the profile deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a single profile.", - "description": "Get a single profile in the current IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.getProfile", - "responses": { - "200": { - "description": "Contains the metadata and data of a profile.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - } - }, - "profile": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Profiles.admin", "Profiles.apiread"], - "CookieAuth": ["Profiles.admin", "Profiles.apiread"], - "BasicAuth": ["Profiles.admin", "Profiles.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates a profile.", - "description": "Update a profile in IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.updateProfile", - "responses": { - "200": { - "description": "The output of the update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "uiProps": { - "$ref": "#/components/schemas/iap_profiles-schema_uiProps" - }, - "authenticationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" - }, - "expressProps": { - "$ref": "#/components/schemas/iap_profiles-schema_expressProps" - }, - "loggerProps": { - "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" - }, - "redisProps": { - "$ref": "#/components/schemas/iap_profiles-schema_redisProps" - }, - "auditProps": { - "$ref": "#/components/schemas/iap_profiles-schema_auditProps" - }, - "pathProps": { - "$ref": "#/components/schemas/iap_profiles-schema_pathProps" - }, - "alarmProps": { - "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" - }, - "id": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - }, - "services": { - "$ref": "#/components/schemas/iap_profiles-schema_services" - }, - "description": { - "$ref": "#/components/schemas/iap_profiles-schema_description" - }, - "adapterStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" - }, - "systemProps": { - "$ref": "#/components/schemas/iap_profiles-schema_systemProps" - }, - "integrationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" - }, - "retryStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" - }, - "serviceDirectory": { - "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/profiles/{id}/export": { - "get": { - "summary": "Export a single profile.", - "description": "Exports a single profile in the current IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.exportProfile", - "responses": { - "200": { - "description": "Contains the metadata and data of a profile.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Profiles.admin", "Profiles.apiread"], - "CookieAuth": ["Profiles.admin", "Profiles.apiread"], - "BasicAuth": ["Profiles.admin", "Profiles.apiread"] - } - ], - "deprecated": false - } - }, - "/profiles/{id}/active": { - "put": { - "summary": "Switch the active profile.", - "description": "Switch the active profile in the current IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.switchActiveProfile", - "responses": { - "200": { - "description": "The output of the profile creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": true - } - }, - "/oauth/serviceAccounts": { - "post": { - "summary": "Create a service account in the database.", - "description": "Create a service account in the database.", - "tags": ["oauth"], - "parameters": [], - "operationId": "OAuth.createServiceAccount", - "responses": { - "200": { - "description": "result", - "content": { - "application/json": { - "schema": { - "title": "result", - "description": "The client credentials for a new service account", - "type": "object", - "properties": { - "client_id": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - }, - "client_secret": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountData": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - } - } - } - } - } - }, - "get": { - "summary": "Get service accounts from the database.", - "description": "Get service accounts from the database.", - "tags": ["oauth"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "OAuth.getServiceAccounts", - "responses": { - "200": { - "description": "The service accounts matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - }, - "client_id": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" - }, - "createdBy": { - "$ref": "#/components/schemas/iap_service-accounts-schema_modifiedByDereferenced" - }, - "updated": { - "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" - }, - "updatedBy": { - "$ref": "#/components/schemas/iap_service-accounts-schema_modifiedByDereferenced" - }, - "secretUpdated": { - "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" - } - } - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false - } - }, - "/oauth/serviceAccounts/{client_id}": { - "patch": { - "summary": "Updates a service account in the database.", - "description": "Updates a service account in the database.", - "tags": ["oauth"], - "parameters": [ - { - "name": "client_id", - "in": "path", - "description": "The clientId for the service account", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - } - } - ], - "operationId": "OAuth.updateServiceAccount", - "responses": { - "200": { - "description": "The output of the service account update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Deletes a service account in the database.", - "description": "Deletes a service account in the database.", - "tags": ["oauth"], - "parameters": [ - { - "name": "client_id", - "in": "path", - "description": "The clientId for the service account", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - } - } - ], - "operationId": "OAuth.deleteServiceAccount", - "responses": { - "200": { - "description": "Result of service account deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false - } - }, - "/oauth/serviceAccounts/{client_id}/regenerate": { - "patch": { - "summary": "Regenerates the client_secret and returns the new value", - "description": "Regenerates the client_secret and returns the new value", - "tags": ["oauth"], - "parameters": [ - { - "name": "client_id", - "in": "path", - "description": "The clientId for the service account", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - } - } - ], - "operationId": "OAuth.regenerateSecret", - "responses": { - "200": { - "description": "The new client credentials for a service account", - "content": { - "application/json": { - "schema": { - "title": "result", - "description": "The updated client credentials for an existing service account", - "type": "object", - "properties": { - "client_id": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - }, - "client_secret": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false - } - }, - "/oauth/token": { - "post": { - "summary": "Retrieve a JWT from a client's credentials", - "description": "Retrieve a JWT from a client's credentials", - "tags": ["oauth"], - "parameters": [], - "operationId": "OAuth.machineAuthentication", - "responses": { - "200": { - "description": "result", - "content": { - "application/json": { - "schema": { - "title": "result", - "description": "A result containing the JWT providing the user access to IAP for a set amount of time", - "type": "object", - "properties": { - "access_token": { - "description": "The JWT providing the user access to IAP", - "type": "string" - }, - "token_type": { - "description": "The type of token provided", - "type": "string", - "enum": ["bearer"] - }, - "expires_in": { - "description": "The amount of time until the JWT expires", - "type": "integer", - "enum": [3600] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "client_id": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - }, - "client_secret": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" - }, - "grant_type": { - "type": "string", - "enum": ["client_credentials"] - } - } - } - } - } - } - } - }, - "/transformations/": { - "get": { - "summary": "Search for transformation documents.", - "description": "Search for transformation documents.", - "tags": ["transformations"], - "parameters": [ - { - "name": "incoming", - "in": "query", - "description": "incoming", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "outgoing", - "in": "query", - "description": "outgoing", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "schema", - "in": "query", - "description": "schema", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "not", - "in": "query", - "description": "not", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "expand", - "in": "query", - "description": "expand", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "type": "number" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "type": "number" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "type": "number" - } - }, - { - "name": "exclude-project-members", - "in": "query", - "description": "exclude-project-members", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "operationId": "Jst.searchTransformations", - "responses": { - "200": { - "description": "Transformation documents.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Creates a single transformation.", - "description": "Creates a single transformation.", - "tags": ["transformations"], - "parameters": [], - "operationId": "Jst.createTransformation", - "responses": { - "200": { - "description": "Created transformation document.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "transformation", - "content": { - "application/json": { - "schema": { - "title": "transformation", - "type": "object" - } - } - } - } - } - }, - "/transformations/import": { - "post": { - "summary": "Imports a single transformation.", - "description": "Imports a single transformation.", - "tags": ["transformations"], - "parameters": [], - "operationId": "Jst.importTransformation", - "responses": { - "200": { - "description": "Imported transformation document.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "transformation", - "content": { - "application/json": { - "schema": { - "title": "transformation", - "type": "object" - } - } - } - } - } - }, - "/transformations/{id}": { - "get": { - "summary": "Gets transformation document by id.", - "description": "Gets transformation document by id.", - "tags": ["transformations"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "Jst.getTransformation", - "responses": { - "200": { - "description": "Transformation document.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates a single transformation.", - "description": "Updates a single transformation.", - "tags": ["transformations"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "Jst.updateTransformation", - "responses": { - "200": { - "description": "Updated transformation document.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "transformation", - "content": { - "application/json": { - "schema": { - "title": "transformation", - "type": "object" - } - } - } - } - }, - "delete": { - "summary": "Deletes a single transformation document.", - "description": "Deletes a single transformation document.", - "tags": ["transformations"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "Jst.deleteTransformation", - "responses": { - "200": { - "description": "Deletion result.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Runs a transformation.", - "description": "Runs a transformation.", - "tags": ["transformations"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "Jst.runTransformation", - "responses": { - "200": { - "description": "Transformation run result.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "incoming": { - "title": "incoming", - "type": "object" - }, - "options": { - "title": "options", - "type": "object" - } - } - } - } - } - } - } - }, - "/formbuilder/saveForm": { - "post": { - "summary": "Save a Generated Form", - "description": "Save a generated form with its data.", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.saveForm", - "responses": { - "200": { - "description": "Status of save form", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "formData": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - } - } - } - } - }, - "/formbuilder/getFormByName/{form_name}": { - "get": { - "summary": "Get Details of Form by Name", - "description": "Get details for a specific form by name", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "form_name", - "in": "path", - "description": "Form name", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.getFormByName", - "responses": { - "200": { - "description": "Forms details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/preserveFormData": { - "post": { - "summary": "Preserve incoming form data format", - "description": "Find and revert containers object/array mutation", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.preserveFormData", - "responses": { - "200": { - "description": "Forms details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "form_name": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - }, - "data": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - } - } - } - } - }, - "/formbuilder/getForm/{form_id}": { - "get": { - "summary": "Get Details of Form by ID", - "description": "Get details for a specific form from by ID", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "form_id", - "in": "path", - "description": "Form ID", - "required": true, - "schema": { - "title": "form_id", - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - } - } - ], - "operationId": "FormBuilder.getForm", - "responses": { - "200": { - "description": "Forms details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/listForms": { - "get": { - "summary": "List All Form Names", - "description": "List the names of all available forms", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.listForms", - "responses": { - "200": { - "description": "Array of form names", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "array", - "items": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - }, - "uniqueItems": true - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/forms/search": { - "post": { - "summary": "Search Forms", - "description": "Search forms with options", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.searchForms", - "responses": { - "200": { - "description": "Array of objects containing forms", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "array", - "items": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "filter": { - "type": "object", - "examples": [ - { - "name": "form_example_1" - } - ] - }, - "startAt": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "maxResults": { - "type": "integer", - "minimum": 0, - "maximum": 100, - "examples": [10] - }, - "sort": { - "type": "object", - "examples": [ - { - "name": 1 - } - ] - }, - "fields": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "children", - "elements", - "createddBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - "examples": [ - [ - "name", - "children", - "elements", - "createddBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - ], - "uniqueItems": true - }, - "expand": { - "type": "array", - "items": { - "type": "string", - "enum": ["createdBy", "lastUpdatedBy"] - }, - "examples": [["createdBy", "lastUpdatedBy"]], - "uniqueItems": true - } - } - } - } - } - } - } - } - } - }, - "/formbuilder/fetchData": { - "post": { - "summary": "Get Service Instance Data", - "description": "Returns service related data", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.fetchData", - "responses": { - "200": { - "description": "Json object of service instance", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "examples": [ - { - "/ncs:services/test:choices": [ - { - "service-name": "service_name_1", - "choice-a": "1" - } - ] - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "FormBuilder.admin", - "FormBuilder.apiwrite", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiwrite", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiwrite", - "FormBuilder.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "service": { - "title": "service", - "type": "string", - "examples": ["/ncs:devices/ncs:device"] - }, - "instance_key": { - "title": "instance_key", - "type": "string", - "examples": ["ncs:name"] - }, - "val": { - "title": "val", - "type": "string", - "examples": ["my_device_01"] - } - } - } - } - } - } - } - }, - "/formbuilder/getElementDefinition/{type}/{id}": { - "get": { - "summary": "Gets an Element Definition.", - "description": "Get the details about a particular element to be used in a form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "type", - "in": "path", - "description": "Element type", - "required": true, - "schema": { - "title": "type", - "type": "string", - "enum": ["service_model", "method"] - } - }, - { - "name": "id", - "in": "path", - "description": "Type ID", - "required": true, - "schema": { - "title": "id", - "type": "string", - "examples": ["/ncs:services/itential_test_devices:multidevice"] - } - } - ], - "operationId": "FormBuilder.getElementDefinition", - "responses": { - "200": { - "description": "Definition of the element", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "examples": [ - { - "children": [], - "type": "service", - "name": "service-name", - "properties": {}, - "key": "s-key", - "namespace": "", - "hosts": ["nso1", "nso2"] - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/listElements": { - "get": { - "summary": "Lists all Elements Usable in Forms", - "description": "Find all elements allowed to be added to a form", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.listElements", - "responses": { - "200": { - "description": "Array of objects containing elements", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_elements" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/deleteForm/{id}": { - "post": { - "summary": "Delete a Form by ID", - "description": "Delete a form from the database by its ID", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Form ID", - "required": true, - "schema": { - "title": "id", - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - } - } - ], - "operationId": "FormBuilder.deleteForm", - "responses": { - "200": { - "description": "Status of delete", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] - } - ], - "deprecated": false - } - }, - "/formbuilder/forms/{name}/groups": { - "get": { - "summary": "List Groups for a Form", - "description": "List the groups that have access to a Form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.listFormGroups", - "responses": { - "200": { - "description": "List of Groups", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_groups" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["FormBuilder.apiread", "FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.apiread", "FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.apiread", "FormBuilder.authorization"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Overwrite Groups for a Form", - "description": "Overwrite the list of groups that have access to a Form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.replaceFormGroups", - "responses": { - "200": { - "description": "Status of Overwrite", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.authorization"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "$ref": "#/components/schemas/formbuilder_formDocument_groups" - } - } - } - } - } - } - }, - "post": { - "summary": "Add Group to Form", - "description": "Add a group to the list of groups for a Form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.createFormGroupEntry", - "responses": { - "200": { - "description": "Status of Overwrite", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.authorization"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "$ref": "#/components/schemas/formbuilder_formDocument_ObjectId" - } - } - } - } - } - } - }, - "delete": { - "summary": "Remove all authorization restriction for a Form", - "description": "Clear all groups that can access a form, making it accessible to everyone", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.deleteFormGroups", - "responses": { - "200": { - "description": "Status of Delete", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.authorization"] - } - ], - "deprecated": false - } - }, - "/formbuilder/forms/{name}/groups/{group}": { - "delete": { - "summary": "Remove a Group from a Form", - "description": "Remove a group from the list of authorized groups for a Form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - }, - { - "name": "group", - "in": "path", - "description": "A Group ID", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_ObjectId" - } - } - ], - "operationId": "FormBuilder.removeFormGroup", - "responses": { - "200": { - "description": "Status of Removal", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.authorization"] - } - ], - "deprecated": false - } - }, - "/formbuilder/forms/export": { - "post": { - "summary": "Export Form", - "description": "Export a single Form", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.exportForm", - "responses": { - "200": { - "description": "Exported Form", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["FormBuilder.admin", "FormBuilder.apiread"], - "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiread"], - "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/formbuilder_formDocument_uuidv4" - }, - "name": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - }, - "anyOf": [ - { - "required": ["_id"] - }, - { - "required": ["name"] - } - ], - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/formbuilder/forms/import": { - "post": { - "summary": "Import Form", - "description": "Import a single Form", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.importForm", - "responses": { - "200": { - "description": "Import status", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "form": { - "$ref": "#/components/schemas/formbuilder_formDocument" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "adapterMap": { - "type": "object" - } - } - } - } - } - } - } - } - } - }, - "/search/find": { - "post": { - "summary": "Search IAP", - "description": "Search through IAP for results from various collections that match your search term, as well as for results that have tags that match your search term.", - "tags": ["search"], - "parameters": [], - "operationId": "Search.find", - "responses": { - "200": { - "description": "Search results", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/search_searchResults" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Search.admin", "Search.apiwrite"], - "CookieAuth": ["Search.admin", "Search.apiwrite"], - "BasicAuth": ["Search.admin", "Search.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "text": { - "type": "string", - "examples": ["test"] - }, - "limit": { - "type": "integer", - "examples": [20] - }, - "skip": { - "type": "integer", - "examples": [5] - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/devices": { - "post": { - "summary": "Find Devices", - "description": "Gets a specific subset of devices for based on given options", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDevicesFiltered", - "responses": { - "200": { - "description": "Filtered/Sorted Devices", - "content": { - "application/json": { - "schema": { - "title": "devices", - "type": "object", - "properties": { - "entity": { - "const": "device" - }, - "total": { - "type": "integer", - "minimum": 0 - }, - "unique_device_count": { - "type": "integer", - "minimum": 0 - }, - "return_count": { - "type": "integer", - "minimum": 0 - }, - "start_index": { - "type": "integer", - "minimum": 0 - }, - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceDetails" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "start": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "limit": { - "type": "integer", - "minimum": 1, - "examples": [20] - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "address": { - "type": "string", - "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", - "examples": ["10.1.98.234"] - }, - "port": { - "type": "string", - "pattern": "^[0-9]+$", - "examples": ["22"] - } - } - }, - "sort": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "enum": [-1, 1] - }, - "address": { - "enum": [-1, 1] - }, - "port": { - "enum": [-1, 1] - } - } - } - }, - "order": { - "type": "string", - "enum": ["ascending", "descending"] - }, - "adapterType": { - "type": "array", - "items": { - "type": "string", - "examples": ["NSO", "AnsibleManager"] - }, - "uniqueItems": true - }, - "adapterId": { - "type": "array", - "items": { - "type": "string", - "examples": ["ansible-us-east"], - "uniqueItems": true - } - }, - "exactMatch": { - "type": "boolean", - "description": "boolean that indicates if an exact result will be returned or not", - "enum": [true, false] - } - }, - "required": ["limit"] - } - } - } - } - } - } - } - }, - "/configuration_manager/cache/devices/ostype": { - "post": { - "summary": "Fetches OS Types to store into the cache.", - "description": "Gathers all the device OS Types in the current evnironment and stores them in the cache.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.cacheOSTypes", - "responses": { - "200": { - "description": "Cached OS Type data.", - "content": { - "application/json": { - "schema": { - "title": "cacheData", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "interval": { - "type": "integer", - "description": "Determines how often (in hours) the OS Types are cached.", - "examples": [48] - } - } - } - } - } - } - } - } - }, - "get": { - "summary": "Fetches the OSTypes stored in the cache.", - "description": "Gathers all the device OS Types in the current cache.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getCachedOSTypes", - "responses": { - "200": { - "description": "Cached OS Type data.", - "content": { - "application/json": { - "schema": { - "title": "cacheData", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Deletes the cache for os types.", - "description": "Removes the cache in the database for os type values.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteOSTypeCache", - "responses": { - "200": { - "description": "Deletion response.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "string", - "examples": [ - "Successfully deleted the cache for device os types." - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/pins": { - "delete": { - "summary": "Deletes pinned items.", - "description": "Deletes the pinned items permanently from the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deletePins", - "responses": { - "200": { - "description": "Result of the deletion.", - "content": { - "application/json": { - "schema": { - "title": "result", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pinTargets": { - "title": "pinTargets", - "type": "array", - "items": {} - }, - "sourceItem": { - "title": "sourceItem", - "type": "string" - } - } - } - } - } - } - }, - "post": { - "summary": "Add an item to pins or remove from if it already exists", - "description": "Add an item to pins or remove from if it already exists", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.handlePin", - "responses": { - "200": { - "description": "Pin object with details.", - "content": { - "application/json": { - "schema": { - "title": "pin", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "properties": { - "sourceItem": { - "type": "string", - "example": "cm_device_groups" - }, - "target": { - "type": "string", - "example": "CSR_Devices_Group" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/pins/fetch": { - "post": { - "summary": "Get a list of pinned items.", - "description": "Fetches a list of pinned items based on the input parameters. The list of pinned items are specific to the current user or actor. This api supports pagination.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getPins", - "responses": { - "200": { - "description": "Returns the list of pins and the total count.", - "content": { - "application/json": { - "schema": { - "title": "pins", - "type": "object", - "properties": { - "pins": { - "type": "array", - "items": { - "type": "object" - } - }, - "count": { - "type": "number", - "example": "10" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "properties": { - "filter": { - "type": "object", - "example": "{ sourceItem: 'cm_gc' }" - }, - "start": { - "type": "number", - "example": "0" - }, - "limit": { - "type": "number", - "example": "10" - }, - "projection": { - "type": "object", - "example": "{ users: 0 }" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/ismaintenance": { - "get": { - "summary": "Checks if the current version of CM is maintenance or not.", - "description": "Returns a boolean reflecting whether the current Configuration Manager bundle is a maintenance bundle.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.isMaintenance", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/jinja2": { - "post": { - "summary": "Renders a jinja2 template.", - "description": "Takes a jinja2 template a renders output text.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.renderJinja2", - "responses": { - "200": { - "description": "Returns the list of pins and the total count.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "string", - "examples": ["this is a jinja2 template"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "title": "template", - "type": "string", - "example": "this is a {{ varName }} template" - }, - "variables": { - "title": "variables", - "properties": {} - }, - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/adaptertasks/search": { - "post": { - "summary": "Get data for all adapters with tasks.", - "description": "Fetch method/task metadata for all adapters that have it.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getAdapterTasks", - "responses": { - "200": { - "description": "Output of adapters' metadata.", - "content": { - "application/json": { - "schema": { - "title": "adapterData", - "type": "object", - "properties": { - "adapterTasks": { - "type": "object", - "properties": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/adaptertasks": { - "post": { - "summary": "Get data for a specific adapter task.", - "description": "Fetch method/task metadata for an adapter task.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getAdapterTask", - "responses": { - "200": { - "description": "Output of adapter task's metadata.", - "content": { - "application/json": { - "schema": { - "title": "taskData", - "type": "object", - "properties": { - "adapterTasks": { - "type": "object", - "properties": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskName": { - "title": "taskName", - "type": "string", - "examples": ["getConfig", "getServiceModel"] - }, - "origin": { - "title": "origin", - "type": "string", - "examples": ["nso52", "localAAA"] - }, - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/instance": { - "post": { - "summary": "Create a task instance.", - "description": "Create an instance of a task and save it to the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createTaskInstance", - "responses": { - "200": { - "description": "Response of whether the insertion operation failed or succeeded.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "instanceName": { - "title": "instanceName", - "type": "string" - }, - "origin": { - "title": "origin", - "type": "string", - "examples": ["nso52", "localAAA"] - }, - "taskName": { - "title": "taskName", - "type": "string", - "examples": ["getConfig", "getServiceModel"] - }, - "treeId": { - "title": "treeId", - "type": "string", - "examples": ["5f21c92ba6abf82bf5041783"] - }, - "taskParams": { - "title": "taskParams", - "properties": {} - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - }, - "put": { - "summary": "Update a task instance.", - "description": "Update an instance of a task and save it to the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateTaskInstance", - "responses": { - "200": { - "description": "Response of whether the update operation failed or succeeded.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskId": { - "title": "taskId", - "type": "string" - }, - "treeId": { - "title": "treeId", - "type": "string" - }, - "taskParams": { - "title": "taskParams", - "type": "object", - "properties": {} - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete task instance(s).", - "description": "Delete task instance(s) from the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteTaskInstances", - "responses": { - "200": { - "description": "Response of whether the delete operation failed or succeeded.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskIds": { - "title": "taskIds", - "type": "array", - "properties": {}, - "items": {} - }, - "treeId": { - "title": "treeId", - "type": "string" - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/instances": { - "post": { - "summary": "Get task instance(s).", - "description": "Get instance(s) of a task.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getTaskInstances", - "responses": { - "200": { - "description": "Response of whether the get operation failed or succeded (with data).", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "title": "treeId", - "type": "string", - "examples": ["5f21c92ba6abf82bf5041783"] - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "filter": { - "type": "object", - "example": "{ 'instanceName': 'some task instance 1' }" - }, - "nodePath": { - "type": "string", - "example": "base" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/instances/search": { - "post": { - "summary": "Search for task instance(s).", - "description": "Search for task instance(s) using varies options parameters.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchTaskInstances", - "responses": { - "200": { - "description": "Response of whether the get operation failed or succeded (with data).", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "filter": { - "type": "object", - "example": "{ 'instanceName': 'some task instance 1' }" - }, - "nodePath": { - "type": "string", - "example": "base" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/instance/run": { - "post": { - "summary": "Run a task instance.", - "description": "Run an instance of a task and save it to the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runTaskInstance", - "responses": { - "200": { - "description": "Data returned by the execution of the task instance..", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskId": { - "title": "taskId", - "type": "string" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/run": { - "post": { - "summary": "Run an adapter task.", - "description": "Run an adapter task.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runAdapterTask", - "responses": { - "200": { - "description": "Data returned by the exection of the adapter task.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "origin": { - "title": "origin", - "type": "string" - }, - "taskName": { - "title": "taskName", - "type": "string" - }, - "args": { - "title": "args", - "type": "object", - "properties": {} - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/{name}": { - "get": { - "summary": "Get Device Details", - "description": "Get detailed information for a specific device, based on its device name", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.getDevice", - "responses": { - "200": { - "description": "Device's details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceDetails" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/devices/{name}/configuration": { - "get": { - "summary": "Get Device Configuration", - "description": "Get configuration for a specific device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.getDeviceConfig", - "responses": { - "200": { - "description": "Configuration for a specific device", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/devices/{name}/configuration/{format}": { - "get": { - "summary": "Get formatted device config", - "description": "Get device configuration in a given format.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - { - "name": "format", - "in": "path", - "description": "Supported formats by NSO (xml, native, json) & Automation Gateway (native).", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfigurationFormat" - } - } - ], - "operationId": "ConfigurationManager.getDeviceConfigFormat", - "responses": { - "200": { - "description": "Configuration for a specific device", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": true - } - }, - "/configuration_manager/devices/backups": { - "post": { - "summary": "Backup device configuration", - "description": "Backup device configuration in mongo", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.backUpDevice", - "responses": { - "200": { - "description": "Status of backup operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "Device {deviceName} backed up successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backupDescription" - }, - "notes": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backupNotes" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/import/backups": { - "post": { - "summary": "Import backup documents", - "description": "Insert backup documents into the ucm_configs collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importBackup", - "responses": { - "200": { - "description": "Status of backup import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 device backups imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "backups": { - "title": "backups", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backup" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/import/groups": { - "post": { - "summary": "Import device group documents", - "description": "Insert device group documents into the device_groups collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importGroup", - "responses": { - "200": { - "description": "Status of group import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 device groups imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "title": "groups", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_groupDetails" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/backups": { - "post": { - "summary": "Get Device Backup List", - "description": "Fetches backups, requires an options payload. An empty option payload will return the first 25 documents", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getBackups", - "responses": { - "200": { - "description": "List of all backups and the total", - "content": { - "application/json": { - "schema": { - "title": "backups", - "type": "object", - "properties": { - "total": { - "type": "integer", - "minimum": 0 - }, - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backup" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "start": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "limit": { - "type": "integer", - "minimum": 1, - "examples": [20] - }, - "regex": { - "type": "boolean" - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "dateRange": { - "type": "array", - "description": "An array containing the start and end date. Index 0 = start date, index 1 = end date.", - "items": {} - }, - "sort": { - "type": "object", - "properties": { - "name": { - "enum": [-1, 1] - }, - "date": { - "enum": [-1, 1] - } - } - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete one or more device backups by Id", - "description": "This API call will delete device backups based on given Ids", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDeviceBackups", - "responses": { - "200": { - "description": "Status with the number of device backups deleted", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "deleted": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "backupIds": { - "title": "backupIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/backups/list": { - "get": { - "summary": "Gets a list of all backed up devices", - "description": "Returns a list of devices that have one or more backups", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getBackedUpDevices", - "responses": { - "200": { - "description": "List of devices with backups", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/backups/{id}": { - "get": { - "summary": "Get Device Backup", - "description": "Retrieves single backup document by id", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Backup's id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getDeviceBackupById", - "responses": { - "200": { - "description": "JSON object that contains the backed up configuration", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backup" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update a device backup by Id", - "description": "This API call will update the metadata of a device backup by ID", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Backup Id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateDeviceBackupById", - "responses": { - "200": { - "description": "Status of the device backup updated", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "updated": { - "type": "integer", - "enum": [0, 1] - } - }, - "required": ["status", "updated"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backupDescription" - }, - "notes": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backupNotes" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/name/devicegroups": { - "get": { - "summary": "Get Device Group by Name", - "description": "Retrieves a single group document by name", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDeviceGroupByName", - "responses": { - "200": { - "description": "JSON object that contains the device group details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupName": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - } - } - } - } - } - } - } - }, - "/configuration_manager/groups/device/{deviceName}": { - "get": { - "summary": "Gets device groups for a device", - "description": "Finds all the device groups that contain the specified device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.getGroupsForDevice", - "responses": { - "200": { - "description": "List of device groups found", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/devices/{name}/isAlive": { - "get": { - "summary": "Check if device is connected", - "description": "Get connection status of device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.isAlive", - "responses": { - "200": { - "description": "Status of device connection", - "content": { - "application/json": { - "schema": { - "title": "status", - "oneOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/devicegroup": { - "post": { - "summary": "Creates a device group", - "description": "Creates a new device group in pronghorn", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createDeviceGroup", - "responses": { - "200": { - "description": "Result of creating a new device group", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_createGroupResponseWithName" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupName": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - }, - "groupDescription": { - "$ref": "#/components/schemas/configuration_manager_common_standardDescription" - }, - "deviceNames": { - "$ref": "#/components/schemas/configuration_manager_common_multiElementString" - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups": { - "get": { - "summary": "Get all Device Groups", - "description": "Gets a list of all known device groups", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDeviceGroups", - "responses": { - "200": { - "description": "List of device groups found", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Delete device groups", - "description": "Delete specified device groups", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDeviceGroups", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_deleteGroupResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupIds": { - "title": "groupIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/search": { - "post": { - "summary": "Search all Device Groups", - "description": "Gets a list of all device groups that match the search criteria", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchDeviceGroups", - "responses": { - "200": { - "description": "List of device groups that match the search criteria", - "content": { - "application/json": { - "schema": { - "title": "deviceGroups", - "type": "object", - "properties": { - "totalCount": { - "type": "number" - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "s": { - "title": "s", - "type": "string" - }, - "start": { - "title": "start", - "type": "number" - }, - "limit": { - "title": "limit", - "type": "number" - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/query": { - "post": { - "summary": "Search device groups", - "description": "Returns device groups that match the specified input", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchGroups", - "responses": { - "200": { - "description": "List of device groups that match the search criteria", - "content": { - "application/json": { - "schema": { - "title": "deviceGroups", - "type": "object", - "properties": { - "totalCount": { - "type": "number" - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "start": { - "title": "start", - "type": "number" - }, - "limit": { - "title": "limit", - "type": "number" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "regex": { - "type": "boolean", - "description": "Enables global regex/substring search." - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/{id}": { - "get": { - "summary": "Get Device Group by ID", - "description": "Get Device Group by ID", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Group Id or Group Name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getDeviceGroupById", - "responses": { - "200": { - "description": "JSON object that contains the device group details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update device groups", - "description": "Updates the device group's details and devices.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Group Id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateDeviceGroups", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "details": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupDetails" - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/{id}/devices": { - "delete": { - "summary": "Removes devices from a group", - "description": "Removes devices from a device group", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "ConfigurationManager.removeDevicesFromGroup", - "responses": { - "200": { - "description": "Result of removing devices", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "devices": { - "title": "devices", - "type": "array", - "properties": {}, - "items": {} - } - } - } - } - } - } - }, - "post": { - "summary": "Adds new devices to the group", - "description": "Adds devices to a group", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "ConfigurationManager.addDevicesToGroup", - "responses": { - "200": { - "description": "Result of adding new devices to the group", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "devices": { - "title": "devices", - "type": "array", - "properties": {}, - "items": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/name/deviceGroups": { - "delete": { - "summary": "Delete device groups", - "description": "Delete specified device groups", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDeviceGroupsByName", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_deleteGroupResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupNames": { - "title": "groupNames", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/devices": { - "post": { - "summary": "Add device(s) to a group", - "description": "This API call will add device(s) to a device group", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.addDevicesToGroupByName", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupName": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - }, - "deviceNames": { - "$ref": "#/components/schemas/configuration_manager_common_multiElementString" - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete device(s) from a group", - "description": "This API call will delete device(s) from a device group", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDevicesFromGroup", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupName": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - }, - "deviceNames": { - "$ref": "#/components/schemas/configuration_manager_common_multiElementString" - } - } - } - } - } - } - } - }, - "/configuration_manager/lookup_diff": { - "put": { - "summary": "Diff two strings from a lookup.", - "description": "Lookup two strings and return a diff.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.lookupDiff", - "responses": { - "200": { - "description": "diffResult", - "content": { - "application/json": { - "schema": { - "title": "diffResult", - "type": "array", - "items": { - "type": "array" - }, - "examples": [ - [ - [-1, "version 16.12"], - [1, "Building configuration..."], - [0, "service timestamps debug datetime"], - [-1, "msec"], - [0, "localtime"] - ] - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "nextId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "collection": { - "title": "collection", - "type": "string", - "minLength": 1 - }, - "nextCollection": { - "title": "nextCollection", - "type": "string", - "minLength": 1 - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "type": { - "type": "boolean" - }, - "clean": { - "type": "string" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configurations/parser": { - "post": { - "summary": "Create a config parser.", - "description": "Create rules for a parser for breaking down configs in GC.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createConfigParser", - "responses": { - "200": { - "description": "data", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "minLength": 1 - }, - "lexRules": { - "title": "lexRules", - "items": { - "title": "lexRule", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - ["^{", "open_statement_block"], - ["^}", "close_statement_block"] - ] - } - }, - "template": { - "title": "template", - "type": "string", - "enum": ["cisco-ios", "f5-bigip"] - } - } - } - } - } - } - }, - "put": { - "summary": "Update a config parser.", - "description": "Update rules for a parser for breaking down configs in GC.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateConfigParser", - "responses": { - "200": { - "description": "result", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "updated": { - "type": "number" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "minLength": 1 - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "lexRules": { - "type": "array", - "items": { - "title": "ruleDefinitions", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - ["^{", "open_statemen_block"], - ["^}", "close_statemen_block"] - ] - } - }, - "template": { - "type": "string", - "examples": ["cisco-ios"] - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a config parser.", - "description": "Permanently delete a configuration parser.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteConfigParser", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "minLength": 1 - }, - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - }, - "get": { - "summary": "Get all config parsers.", - "description": "Gets a list of all known config parsers.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "start", - "in": "query", - "description": "start", - "required": false, - "schema": { - "type": "integer", - "minimum": 0, - "examples": [0] - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "examples": [20] - } - }, - { - "name": "regex", - "in": "query", - "description": "regex", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "filter", - "in": "query", - "description": "filter", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "integer", - "enum": [-1, 1] - }, - "date": { - "type": "integer", - "enum": [-1, 1] - } - } - } - } - ], - "operationId": "ConfigurationManager.getConfigParsers", - "responses": { - "200": { - "description": "List of config parsers found", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "array", - "items": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/configurations/parser/search": { - "post": { - "summary": "Get a config parser.", - "description": "Get a defined Config Parser from the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getConfigParser", - "responses": { - "200": { - "description": "data", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": { - "parser": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "filter": { - "title": "filter", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/configurations/parsers": { - "delete": { - "summary": "Delete one or more config parsers by Id", - "description": "This API call will delete config parsers based on given Ids", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteConfigParsers", - "responses": { - "200": { - "description": "Status with the number of config parsers deleted", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "deleted": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "parserIds": { - "title": "parserIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/import/parsers": { - "post": { - "summary": "Import parser documents", - "description": "Insert parser documents into the ucm_configs collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importParsers", - "responses": { - "200": { - "description": "Status of parser import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 device parsers imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "parsers": { - "title": "parsers", - "type": "array", - "items": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/configs": { - "get": { - "summary": "Get a list of all Golden Config trees.", - "description": "Get a list of all Golden Config trees.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getGoldenConfigTrees", - "responses": { - "200": { - "description": "List of all Golden Config trees", - "content": { - "application/json": { - "schema": { - "title": "goldenConfigTrees", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Adds a new Golden Config tree", - "description": "Adds a new Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createGoldenConfigTree", - "responses": { - "200": { - "description": "details of the initial version of the newly created tree", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": [ - "Cisco Edge - Day 0", - "Cisco Edge - Day 1", - "Cisco Core - Day 0", - "Cisco Core - Day 1" - ] - }, - "deviceType": { - "title": "deviceType", - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete one or more golden configuration trees by tree id", - "description": "This API call will delete golden configuration trees based on given tree ids", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteGoldenConfigTrees", - "responses": { - "200": { - "description": "Status with the number of golden configurations deleted", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "deleted": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeIds": { - "title": "treeIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/{treeId}": { - "get": { - "summary": "Get summary of a Golden Config tree.", - "description": "Get summary of the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getGoldenConfigTree", - "responses": { - "200": { - "description": "Requested Golden Config tree", - "content": { - "application/json": { - "schema": { - "title": "tree", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Adds a new Golden Config tree", - "description": "Adds a new Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "ID of the new Golden Config tree", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.createGoldenConfigTreeVersion", - "responses": { - "200": { - "description": "details of the initial version of the newly created tree", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "base": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - } - } - } - } - }, - "put": { - "summary": "Updates properties of a Golden Config tree", - "description": "Updates properties of the specified Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateGoldenConfigTree", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config tree updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["GC Tree Name"] - }, - "gbac": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - } - } - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a Golden Config tree.", - "description": "Deletes the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.deleteGoldenConfigTree", - "responses": { - "200": { - "description": "Result of the delete request", - "content": { - "application/json": { - "schema": { - "title": "deleteResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config tree deleted"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/configs/{treeId}/{version}": { - "get": { - "summary": "Get details of a Golden Config tree version.", - "description": "Get a detailed view of the specified Golden Config tree version.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - ], - "operationId": "ConfigurationManager.getGoldenConfigTreeVersion", - "responses": { - "200": { - "description": "Requested Golden Config tree version", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates properties of a Golden Config tree version", - "description": "Updates properties of the specified Golden Config tree version", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - ], - "operationId": "ConfigurationManager.updateGoldenConfigTreeVersion", - "responses": { - "200": { - "description": "status of creation and the new tree, if successful", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Configuration tree version updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["updated version name"] - }, - "variables": { - "title": "variables", - "type": "object", - "properties": {} - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a Golden Config tree.", - "description": "Deletes the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - ], - "operationId": "ConfigurationManager.deleteGoldenConfigTreeVersion", - "responses": { - "200": { - "description": "Result of the delete request", - "content": { - "application/json": { - "schema": { - "title": "deleteResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Configuration tree version deleted"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/search/configs": { - "post": { - "summary": "Get summary of a Golden Config tree.", - "description": "Get summary of the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchGoldenConfigTrees", - "responses": { - "200": { - "description": "List of all Golden Config trees", - "content": { - "application/json": { - "schema": { - "title": "goldenConfigTrees", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "properties": { - "start": { - "type": "number", - "example": "0" - }, - "limit": { - "type": "number", - "example": "10" - }, - "sort": { - "type": "number", - "example": 1 - }, - "deviceType": { - "type": "string", - "example": "cisco-ios" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/device/trees": { - "post": { - "summary": "Find trees which contain the specified device.", - "description": "Search through all GC Trees to find all locations where a device exists.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getTreesForDevice", - "responses": { - "200": { - "description": "List of trees that the device belongs to.", - "content": { - "application/json": { - "schema": { - "title": "trees", - "type": "array", - "items": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/tree": { - "post": { - "summary": "Fetches all the devices that exist on a tree.", - "description": "Search through a GC Tree to find all the devices that exist on it.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDevicesOnTree", - "responses": { - "200": { - "description": "Response containing the list of devices.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "nodes": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/variables/{treeId}/{version}": { - "delete": { - "summary": "Deletes one or more variables", - "description": "Verifies and deletes the requested deletion variables", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - ], - "operationId": "ConfigurationManager.deleteVariables", - "responses": { - "200": { - "description": "status of the variables to delete", - "content": { - "application/json": { - "schema": { - "title": "deleteResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Deletion successful."] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "variables": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigVariables" - } - } - } - } - } - } - } - }, - "/configuration_manager/configurations/rules": { - "put": { - "summary": "Updates the config rule set of a JSON Golden Config tree version", - "description": "Updates the config rule set of a JSON Golden Config tree version", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateJSONConfigRules", - "responses": { - "200": { - "description": "status of the rule set update.", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Rule Set successfully updated."] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "ruleSet": { - "title": "ruleSet", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/devices/groups": { - "delete": { - "summary": "Remove Device Groups from Node", - "description": "Remove device groups from a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.removeGroupsFromNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "deviceGroups": { - "title": "deviceGroups", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Add Device Groups to Node", - "description": "Add device groups to a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.addGroupsToNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "deviceGroups": { - "title": "deviceGroups", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/export/goldenconfigs": { - "post": { - "summary": "Export a Golden Config tree.", - "description": "Exports the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.exportGoldenConfigTree", - "responses": { - "200": { - "description": "Dereferenced golden config tree", - "content": { - "application/json": { - "schema": { - "title": "exportResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "data": { - "type": "array", - "title": "data", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - }, - "/configuration_manager/import/goldenconfigs": { - "post": { - "summary": "Import golden config tree documents", - "description": "Insert golden config documents into the golden config collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importGoldenConfigTree", - "responses": { - "200": { - "description": "Status of golden config import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 golden config trees imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "trees": { - "title": "trees", - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "array", - "description": "Documents of given tree per version", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/node/tasks": { - "delete": { - "summary": "Remove Tasks from Node", - "description": "Remove Tasks from a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.removeTasksFromNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "tasks": { - "title": "tasks", - "type": "array", - "items": { - "type": "string", - "title": "taskId", - "examples": ["5f9700486aa2ad95d85fc973"] - } - } - } - } - } - } - } - }, - "post": { - "summary": "Add Tasks to Node", - "description": "Add Tasks to a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.addTasksToNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "tasks": { - "title": "tasks", - "type": "array", - "items": { - "type": "string", - "title": "taskId", - "examples": ["5f9700486aa2ad95d85fc973"] - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/{treeId}/{version}/{nodePath(*)}/devices": { - "post": { - "summary": "Add Devices to Node", - "description": "Add devices to a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.addDevicesToNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "devices": { - "title": "devices", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Remove Devices from Node", - "description": "Remove devices from a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.removeDevicesFromNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "devices": { - "title": "devices", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/{treeId}/{version}/{parentNodePath(*)}": { - "post": { - "summary": "Create a new node in a Golden Config tree.", - "description": "Create a new node in the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "parentNodePath", - "in": "path", - "description": "parentNodePath", - "required": true, - "schema": { - "title": "parentNodePath", - "type": "string", - "examples": ["base/US East"] - } - } - ], - "operationId": "ConfigurationManager.createGoldenConfigNode", - "responses": { - "200": { - "description": "Newly created node", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNode" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["DC"] - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/{treeId}/{version}/{nodePath(*)}": { - "put": { - "summary": "Update properties of a node in a Golden Config tree.", - "description": "Update properties of the specified Golden Config node.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.updateGoldenConfigNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["Southeast"] - }, - "attributes": { - "title": "attributes", - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "configId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a node in a Golden Config tree.", - "description": "Permanently delete the specified node in the Golden Config tree. Not reversible.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.deleteGoldenConfigNode", - "responses": { - "200": { - "description": "deleteNodeResult", - "content": { - "application/json": { - "schema": { - "title": "deleteNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Configuration node deleted"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/config_specs/{id}": { - "get": { - "summary": "Get a Config Spec document.", - "description": "Get the details of the specified Config Spec.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getConfigSpec", - "responses": { - "200": { - "description": "configSpec", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpec" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update a Config Spec.", - "description": "Update content of the Config Spec.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateConfigSpec", - "responses": { - "200": { - "description": "configSpecUpdateResult", - "content": { - "application/json": { - "schema": { - "title": "configSpecUpdateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Config Spec updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "template": { - "type": "string", - "examples": ["ntp server {{ ipAddress }}"] - }, - "variables": { - "type": "string", - "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/config_template": { - "post": { - "summary": "Get a Config Spec template.", - "description": "Get the template of the specified Config Spec", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getConfigTemplate", - "responses": { - "200": { - "description": "template", - "content": { - "application/json": { - "schema": { - "title": "template", - "type": "object", - "properties": { - "currentTemplate": { - "type": "string" - }, - "inheritedTemplate": { - "type": "string" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/config_specs": { - "post": { - "summary": "Create a new Config Spec.", - "description": "Create a new Config Spec.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createConfigSpec", - "responses": { - "200": { - "description": "configSpec", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpec" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceType": { - "title": "deviceType", - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "data": { - "title": "data", - "type": "object", - "properties": { - "template": { - "type": "string", - "examples": ["ntp server {{ ipAddress }}"] - }, - "variables": { - "type": "string", - "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/node/config": { - "put": { - "summary": "Update node configuration.", - "description": "Updates the configuration for a specified node.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateNodeConfig", - "responses": { - "200": { - "description": "nodeUpdateResult", - "content": { - "application/json": { - "schema": { - "title": "nodeUpdateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Node Config updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "treeVersion": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "data": { - "title": "data", - "type": "object", - "properties": { - "template": { - "type": "string", - "examples": ["ntp server {{ ipAddress }}"] - }, - "variables": { - "type": "string", - "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] - } - } - }, - "updateVariables": { - "title": "updateVariables", - "type": "boolean" - } - } - } - } - } - } - } - }, - "/configuration_manager/translate/config_spec": { - "post": { - "summary": "Convert a config spec into a readable string.", - "description": "Converts a object like config into a human-readable config string.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.translateConfigSpec", - "responses": { - "200": { - "description": "configData", - "content": { - "application/json": { - "schema": { - "title": "configData", - "type": "object", - "properties": { - "config": { - "type": "string", - "examples": [ - "interface Loopback01\n description loopback01" - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeID": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/generate/config_spec": { - "post": { - "summary": "Builds a config spec from raw config.", - "description": "Takes raw native config and builds a configuration spec.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.buildSpecLines", - "responses": { - "200": { - "description": "specLines", - "content": { - "application/json": { - "schema": { - "title": "specLines", - "type": "array", - "properties": {}, - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecLine" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nativeConfig": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfigurationString" - }, - "deviceType": { - "title": "deviceType", - "type": "string", - "enum": [ - "cisco-ios", - "cisco-asa", - "cisco-ios-xr", - "cisco-nx", - "cisco-staros", - "alu-sr", - "a10-acos", - "juniper-junos", - "f5-bigip", - "arista-eos" - ] - }, - "options": { - "title": "options", - "properties": {}, - "type": "object" - } - } - } - } - } - } - } - }, - "/configuration_manager/json_specs/{id}": { - "get": { - "summary": "Get a JSON Spec document.", - "description": "Get the details of the specified JSON Spec.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getJSONSpec", - "responses": { - "200": { - "description": "JSONSpec", - "content": { - "application/json": { - "schema": { - "title": "JSONSpec", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update a JSON Spec", - "description": "Update content of the JSON Spec.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateJSONSpec", - "responses": { - "200": { - "description": "jsonSpecUpdateResult", - "content": { - "application/json": { - "schema": { - "title": "jsonSpecUpdateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["JSON Spec updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/json_specs": { - "post": { - "summary": "Get a JSON Spec document with inheritance.", - "description": "Get the details of the specified JSON Spec with inheritance.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getJSONSpecWithInheritance", - "responses": { - "200": { - "description": "JSONSpec", - "content": { - "application/json": { - "schema": { - "title": "JSONSpec", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/json_specs/create": { - "post": { - "summary": "Create a new JSON Spec.", - "description": "Create a new JSON Spec.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createJSONSpec", - "responses": { - "200": { - "description": "jsonSpec", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigJSONSpec" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/config": { - "post": { - "summary": "Run Compliance Reports.", - "description": "Kick off one or more compliance checks for devices in a specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runConfigCompliance", - "responses": { - "200": { - "description": "runComplianceBatchResult", - "content": { - "application/json": { - "schema": { - "title": "runComplianceBatchResult", - "type": "object", - "properties": { - "status": { - "type": "integer", - "const": 202 - }, - "message": { - "type": "string", - "examples": ["compliance batch ${batchId} started"] - }, - "batchId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceName": { - "title": "deviceName", - "type": "string", - "examples": ["Cisco-Device.1"] - }, - "configuration": { - "title": "configuration", - "type": "string", - "examples": [ - "interface Loopback1\n ip address 10.0.0.1\nntp server 105.62.30.158" - ] - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports": { - "post": { - "summary": "Run Compliance Reports.", - "description": "Kick off one or more compliance checks for devices in a specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runCompliance", - "responses": { - "200": { - "description": "runComplianceBatchResult", - "content": { - "application/json": { - "schema": { - "title": "runComplianceBatchResult", - "type": "object", - "properties": { - "status": { - "type": "integer", - "const": 202 - }, - "message": { - "type": "string", - "examples": ["compliance batch ${batchId} started"] - }, - "batchId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "tasks": { - "type": "array", - "items": { - "type": "string" - }, - "examples": ["5f7b4c5ab2f4e0690520eed2"] - }, - "variables": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigVariables" - }, - "bidirectional": { - "type": "boolean" - } - }, - "required": ["treeId", "version"] - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/backups": { - "post": { - "summary": "Run Compliance Reports on Backups.", - "description": "Kick off one or more compliance checks for backups in a specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runComplianceOnBackups", - "responses": { - "200": { - "description": "runComplianceBatchResult", - "content": { - "application/json": { - "schema": { - "title": "runComplianceBatchResult", - "type": "object", - "properties": { - "status": { - "type": "integer", - "const": 202 - }, - "message": { - "type": "string", - "examples": ["compliance batch ${batchId} started"] - }, - "batchId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeInfo": { - "title": "treeInfo", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - } - }, - "required": ["treeId", "version", "nodePath"] - }, - "backupIds": { - "title": "backupIds", - "type": "array", - "items": { - "type": "string", - "title": "backupId", - "examples": ["5f9700486aa2ad95d85fc973"] - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "bidirectional": { - "type": "boolean" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/tree/{treeId}": { - "get": { - "summary": "Summarize Compliance Reports for a Tree.", - "description": "Summarize Compliance Reports for a Tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getComplianceReportTreeSummary", - "responses": { - "200": { - "description": "complianceSummary", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceSummary" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/compliance_reports/node/{treeId}/{nodePath(*)}": { - "get": { - "summary": "Summarize Compliance Reports for a Node.", - "description": "Summarize Compliance Reports for a Node.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.getComplianceReportNodeSummary", - "responses": { - "200": { - "description": "complianceSummary", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceSummary" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/compliance_reports/grade": { - "post": { - "summary": "Get graded compliance reports for a node.", - "description": "Get a set of graded and scored compliance reports for a node.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.gradeComplianceReports", - "responses": { - "200": { - "description": "graded_compliance_reports", - "content": { - "application/json": { - "schema": { - "title": "graded_compliance_reports", - "type": "array", - "items": { - "type": "object", - "properties": { - "grade": { - "type": "string", - "examples": ["pass", "review", "fail"] - }, - "total": { - "type": "integer", - "minimum": 0 - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "records": { - "type": "array", - "items": { - "type": "object", - "properties": { - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "reportId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "timestamp": { - "$ref": "#/components/schemas/configuration_manager_common_timestamp" - }, - "score": { - "type": "number" - }, - "grade": { - "type": "string", - "examples": ["pass", "review", "fail"] - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "options": { - "title": "options", - "allOf": [ - { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_reportGradingOptions" - }, - { - "type": "object", - "properties": { - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - } - ] - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/grade/single": { - "post": { - "summary": "Grade Report", - "description": "Get graded compliance report", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.gradeComplianceReport", - "responses": { - "200": { - "description": "graded_compliance_report", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportGraded" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reportId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_reportGradingOptions" - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/grade/history": { - "post": { - "summary": "Get historical graded compliance reports.", - "description": "Get historical graded compliance reports for a device on a node.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.gradeDeviceComplianceHistory", - "responses": { - "200": { - "description": "graded_compliance_history", - "content": { - "application/json": { - "schema": { - "title": "graded_compliance_history", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "options": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" - } - } - } - } - } - } - } - }, - "/configuration_manager/json_compliance_reports/grade/history": { - "post": { - "summary": "Get historical graded compliance reports.", - "description": "Get historical graded compliance reports for a task instance on a node.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.gradeTaskComplianceHistory", - "responses": { - "200": { - "description": "graded_compliance_history", - "content": { - "application/json": { - "schema": { - "title": "graded_compliance_history", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "taskId": { - "title": "taskId", - "type": "string", - "examples": ["5f80bd24f8479975bb46054d"] - }, - "options": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/query/history": { - "post": { - "summary": "Get historical graded compliance reports with pagination support.", - "description": "Get historical graded compliance reports for a device on a node with pagination support.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.queryGradedComplianceHistory", - "responses": { - "200": { - "description": "graded_compliance_history", - "content": { - "application/json": { - "schema": { - "title": "graded_compliance_history", - "properties": { - "total": { - "title": "total", - "type": "number" - }, - "history": { - "title": "history", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "filter": { - "title": "filter", - "properties": { - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "taskId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - }, - "options": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/batch/{batchId}": { - "get": { - "summary": "Get compliance report metadata for a batch.", - "description": "Get compliance report metadata by batch ID.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "batchId", - "in": "path", - "description": "batchId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getComplianceReportsByBatch", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/json_compliance_reports/batch/{batchId}": { - "get": { - "summary": "Get compliance report metadata for a batch.", - "description": "Get compliance report metadata by batch ID.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "batchId", - "in": "path", - "description": "batchId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getJSONComplianceReportsByBatch", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/compliance_reports/history": { - "post": { - "summary": "Compliance Reports totals for a Device.", - "description": "Compliance Reports totals for a Device.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getComplianceReportDeviceHistory", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "limit": { - "type": "integer", - "minimum": 1 - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/history/backups": { - "post": { - "summary": "Compliance Reports totals for a Backup.", - "description": "Compliance Reports totals for a Backup.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getComplianceReportBackupHistory", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "backups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "limit": { - "type": "integer", - "minimum": 1 - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/json_compliance_reports/history": { - "post": { - "summary": "Compliance Reports totals for a Task Instance.", - "description": "Compliance Reports totals for a Task Instance.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getComplianceReportTaskHistory", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "taskIds": { - "type": "array", - "items": { - "type": "string", - "title": "taskIds", - "examples": ["5f1063d78cf3b62347de4b87"] - } - }, - "limit": { - "type": "integer", - "minimum": 1 - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/details/{reportId}": { - "get": { - "summary": "Get Compliance Report", - "description": "Get the details of a particular compliance report", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "reportId", - "in": "path", - "description": "reportId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getComplianceReportDetail", - "responses": { - "200": { - "description": "complianceReportDetail", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/json_compliance_reports/details/{reportId}": { - "get": { - "summary": "Get JSON Compliance Report", - "description": "Get the details of a particular JSON compliance report", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "reportId", - "in": "path", - "description": "reportId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getJSONComplianceReportDetail", - "responses": { - "200": { - "description": "complianceReportDetail", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/compliance_reports/details": { - "post": { - "summary": "Get details of a particular set of compliance checks.", - "description": "Get details of a particular set of compliance checks.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getComplianceReportsDetail", - "responses": { - "200": { - "description": "complianceReportsDetail", - "content": { - "application/json": { - "schema": { - "title": "complianceReportsDetail", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reportIds": { - "title": "reportIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/topissues": { - "post": { - "summary": "Get the top issues from compliance reports", - "description": "Get the top most offending issues from all latest compliance reports", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getTopIssues", - "responses": { - "200": { - "description": "topIssuesResults", - "content": { - "application/json": { - "schema": { - "title": "topIssuesResults", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecLineId" - }, - "specWords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecWord" - } - }, - "count": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/json_compliance_reports/topissues": { - "post": { - "summary": "Get the top issues from JSON compliance reports", - "description": "Get the top most offending issues from all latest JSON compliance reports", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getTopIssuesJson", - "responses": { - "200": { - "description": "topIssuesResults", - "content": { - "application/json": { - "schema": { - "title": "topIssuesResults", - "type": "array", - "items": { - "type": "object", - "properties": {} - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/patch_device/{deviceName}": { - "post": { - "summary": "Alters a device configuration", - "description": "Apply specified changes to a device configuration", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "deviceName", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.patchDeviceConfiguration", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "patchResult", - "type": "object", - "properties": { - "response": { - "type": "array", - "items": { - "type": "object", - "properties": { - "result": { - "type": "boolean" - }, - "parents": { - "type": "array", - "items": { - "type": "string" - } - }, - "new": { - "type": "string" - }, - "old": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "changes": { - "title": "changes", - "type": "array", - "items": { - "type": "object", - "properties": { - "parents": { - "type": "array", - "items": { - "type": "string", - "examples": ["parent line of config"] - } - }, - "old": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["old config line", null] - }, - "new": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["new config line", null] - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/patch_device/advanced/{deviceName}": { - "post": { - "summary": "Alters a device configuration", - "description": "Apply specified changes to a device configuration with additional options", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "deviceName", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.advancedPatchDeviceConfiguration", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "patchResult", - "type": "object", - "properties": { - "response": { - "type": "array", - "items": { - "type": "object", - "properties": { - "result": { - "type": "boolean" - }, - "parents": { - "type": "array", - "items": { - "type": "string" - } - }, - "new": { - "type": "string" - }, - "old": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "changes": { - "title": "changes", - "type": "array", - "items": { - "type": "object", - "properties": { - "parents": { - "type": "array", - "items": { - "type": "string", - "examples": ["parent line of config"] - } - }, - "old": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["old config line", null] - }, - "new": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["new config line", null] - } - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "backupDevice": { - "type": "boolean" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/changes/convert": { - "post": { - "summary": "Converts patch data to native config.", - "description": "Converts the config patch data into a readable native config.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.convertChangesToConfig", - "responses": { - "200": { - "description": "configData", - "content": { - "application/json": { - "schema": { - "title": "configData", - "type": "object", - "properties": { - "config": { - "type": "string", - "examples": [ - "interface Loopback01\n description loopback01" - ] - }, - "changes": { - "type": "array", - "items": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceType": { - "title": "deviceType", - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "changes": { - "title": "changes", - "type": "array", - "items": { - "type": "object", - "properties": { - "parents": { - "type": "array", - "items": { - "type": "string", - "examples": ["parent line of config"] - } - }, - "old": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["old config line", null] - }, - "new": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["new config line", null] - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/actions/{device&:origin&:action}": { - "get": { - "summary": "Call Adapter Method", - "description": "Perform south bound specific logic via direct adapter call(s)", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "device", - "in": "path", - "description": "device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - { - "name": "origin", - "in": "path", - "description": "origin name", - "required": true, - "schema": { - "title": "origin", - "type": "string", - "examples": ["nso46", "ansible-us"] - } - }, - { - "name": "action", - "in": "path", - "description": "adapter action/function to be called", - "required": true, - "schema": { - "title": "action", - "type": "string", - "examples": ["checkSync"] - } - } - ], - "operationId": "ConfigurationManager.adapterProxy", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "adapterResponse", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/templates": { - "post": { - "summary": "Creates a device template", - "description": "Creates a new device template in pronghorn", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createDeviceTemplate", - "responses": { - "200": { - "description": "Result of creating a new device template", - "content": { - "application/json": { - "schema": { - "title": "data", - "properties": { - "result": { - "type": "string", - "example": "success" - }, - "data": { - "type": "object", - "example": { - "id": "610315295595a5fcb99f8ce2", - "name": "Cisco Login Banner", - "template": "banner login {{ bannerBody }}", - "variables": { - "bannerBody": "Welcome to this Cisco Device." - }, - "created": "2021-07-29T20:52:57.378Z", - "updated": "2021-07-29T20:52:57.378Z", - "createdBy": "5eaaf3796b16027c8aeb612a", - "updatedBy": "5eaaf3796b16027c8aeb612a", - "gbac": { - "write": [], - "read": [] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "template": { - "title": "template", - "type": "string", - "examples": [ - "interface Loopback1\n description {{ description }}" - ] - }, - "variables": { - "title": "variables", - "type": "object", - "properties": {} - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "deviceOSTypes": { - "type": "array" - } - } - } - } - } - } - } - } - }, - "put": { - "summary": "Updates a device template", - "description": "Updates a new device template in pronghorn", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateDeviceTemplate", - "responses": { - "200": { - "description": "Result of creating a new device template", - "content": { - "application/json": { - "schema": { - "title": "data", - "properties": { - "status": { - "type": "string", - "example": "success" - }, - "updated": { - "type": "number", - "example": 2 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "data": { - "title": "data", - "properties": { - "template": { - "type": "string", - "example": "ntp server {{ ipAddress }}" - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - }, - "name": { - "type": "string", - "example": "NTP Server Template" - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "deviceOSTypes": { - "type": "array" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete one or more device template(s) by Id", - "description": "This API call will delete device templates based on given Ids", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDeviceTemplates", - "responses": { - "200": { - "description": "Status with the number of device templates deleted", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "deleted": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "templateIds": { - "title": "templateIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/templates/search": { - "post": { - "summary": "Gets a device template", - "description": "Gets a new device template in pronghorn", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDeviceTemplates", - "responses": { - "200": { - "description": "Result of creating a new device template", - "content": { - "application/json": { - "schema": { - "title": "data", - "properties": { - "total": { - "type": "number", - "example": 1 - }, - "list": { - "type": "object", - "example": [ - { - "id": "610315295595a5fcb99f8ce2", - "name": "Cisco Login Banner", - "template": "banner login {{ bannerBody }}", - "variables": { - "bannerBody": "Welcome to this Cisco Device." - }, - "created": "2021-07-29T20:52:57.378Z", - "updated": "2021-07-29T20:52:57.378Z", - "createdBy": "5eaaf3796b16027c8aeb612a", - "updatedBy": "5eaaf3796b16027c8aeb612a", - "gbac": { - "write": [], - "read": [] - } - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/import/templates": { - "post": { - "summary": "Import device config template documents", - "description": "Insert device config template documents into the device_templates collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importDeviceTemplates", - "responses": { - "200": { - "description": "Status of template import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 device template imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "templates": { - "title": "templates", - "type": "array", - "items": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/{deviceName}/configuration": { - "post": { - "summary": "Apply a device config", - "description": "This API call will apply a configuration to a specified device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.applyDeviceConfig", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "config": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/templates/apply": { - "post": { - "summary": "Apply a device config template", - "description": "This API call will apply a configuration template to a specified device", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.applyDeviceTemplate", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "templateId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/{deviceName}/operationaldata": { - "post": { - "summary": "Get operational data for a device", - "description": "Gets all the operational data for the specified device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.getOperationalData", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "filter": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/import/plans": { - "post": { - "summary": "Import compliance plan documents", - "description": "Insert compliance plan documents into the ucm_compliance_plans collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importCompliancePlan", - "responses": { - "200": { - "description": "Status of compliance plan import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 compliance plan(s) imported successfully." - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "plans": { - "title": "plans", - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "description": "The ID of the compliance plan." - }, - "name": { - "type": "string", - "description": "The name of the compliance plan to import" - }, - "description": { - "type": "string", - "description": "The description of the compliance plan to import" - }, - "nodes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "treeId": { - "type": "string", - "description": "The treeId of the GC that the node belongs to." - }, - "version": { - "type": "string", - "description": "The version of the GC tree that the node belongs to." - }, - "nodeId": { - "type": "string", - "description": "The configId of the node." - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - } - } - } - }, - "gbac": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plans": { - "post": { - "summary": "Creates a compliance plan", - "description": "Creates a compliance plan which can be used to execute compliance reports", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createCompliancePlan", - "responses": { - "200": { - "description": "Details of the newly created compliance plan", - "content": { - "application/json": { - "schema": { - "title": "compliancePlan", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["Firewall Policies"] - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the compliance plan.", - "examples": ["A compliance plan for firewall configs."] - }, - "nodes": { - "type": "array", - "description": "Nodes to add into the compliance plan.", - "items": { - "type": "object", - "properties": { - "treeId": { - "type": "string", - "description": "The treeId of the GC that the node belongs to." - }, - "version": { - "type": "string", - "description": "The version of the GC tree that the node belongs to." - }, - "nodeId": { - "type": "string", - "description": "The configId of the node." - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "deviceGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "tasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - } - } - } - } - }, - "put": { - "summary": "Updates a compliance plan", - "description": "Updates a compliance plan that already exists", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateCompliancePlan", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Compliance Plan updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the compliance plan.", - "examples": ["A compliance plan for firewall configs."] - }, - "name": { - "type": "string", - "description": "New name for the Compliance Plan", - "examples": ["Firewall Policies"] - }, - "nodes": { - "type": "array", - "description": "Nodes to add into the compliance plan.", - "items": { - "type": "object", - "properties": { - "treeId": { - "type": "string", - "description": "The treeId of the GC that the node belongs to." - }, - "version": { - "type": "string", - "description": "The version of the GC tree that the node belongs to." - }, - "nodeId": { - "type": "string", - "description": "The configId of the node." - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "deviceGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "tasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - }, - "gbac": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - } - } - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete compliance plans", - "description": "Delete the specified compliance plans", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteCompliancePlans", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "title": "deleteResult", - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "deleted": { - "type": "number" - } - }, - "required": ["status", "deleted"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planIds": { - "title": "planIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plans/{planId}": { - "get": { - "summary": "Fetches a compliance plan", - "description": "Fetches a compliance plan with the provided ID", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "planId", - "in": "path", - "description": "planId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getCompliancePlan", - "responses": { - "200": { - "description": "Requested Golden Config tree version", - "content": { - "application/json": { - "schema": { - "title": "compliancePlan", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/search/compliance_plans": { - "post": { - "summary": "Search all Compliance Plans", - "description": "Gets a list of all Compliance Plans that match the search criteria", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchCompliancePlans", - "responses": { - "200": { - "description": "List of Compliance Plans that match the search criteria", - "content": { - "application/json": { - "schema": { - "title": "compliancePlans", - "type": "object", - "properties": { - "totalCount": { - "type": "number" - }, - "groups": { - "type": "array", - "items": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "start": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "limit": { - "type": "integer", - "minimum": 1, - "examples": [20] - }, - "sort": { - "type": "number", - "example": 1 - } - }, - "required": ["start", "limit"] - } - } - } - } - } - } - } - }, - "/configuration_manager/search/compliance_plan_instances": { - "post": { - "summary": "Search all Compliance Plan instances", - "description": "Gets a list of all Compliance Plan Instances that match the search criteria", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchCompliancePlanInstances", - "responses": { - "200": { - "description": "List of Compliance Plan Instances that match the search criteria", - "content": { - "application/json": { - "schema": { - "title": "compliancePlanInstances", - "type": "object", - "properties": { - "totalCount": { - "type": "number" - }, - "groups": { - "type": "array", - "items": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "searchParams": { - "title": "searchParams", - "type": "object", - "properties": { - "instanceId": { - "type": "string", - "description": "ID of the instance to fetch" - }, - "planId": { - "type": "string", - "description": "Fetches all instances with this planId" - }, - "planName": { - "type": "string", - "description": "Fetches all instances with this planName" - }, - "description": { - "type": "string", - "description": "Filter by description of the plan instance.", - "example": ["A description for my compliance plan."] - }, - "status": { - "type": "string", - "description": "Filter by status of the Job pertainig to the plan instance.", - "enum": [ - "running", - "complete", - "paused", - "error", - "canceled" - ] - }, - "dateRange": { - "type": "array", - "description": "An array containing the start and end date. Index 0 = start date, index 1 = end date.", - "items": {} - }, - "start": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "limit": { - "type": "integer", - "minimum": 1, - "examples": [20] - }, - "sort": { - "type": "object", - "properties": { - "started": { - "enum": [-1, 1] - }, - "jobStatus": { - "enum": [-1, 1] - }, - "name": { - "enum": [-1, 1] - } - } - } - }, - "oneOf": [ - { - "required": ["instanceId"] - }, - { - "required": ["planId"] - }, - { - "required": ["planName"] - } - ] - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plans/nodes": { - "post": { - "summary": "Adds node(s) to a compliance plan", - "description": "Adds new node(s) to an already existing compliance plan", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.addNodesToCompliancePlan", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": [ - "Successfully added node(s) to compliance plan" - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "nodes": { - "title": "nodes", - "type": "array", - "items": { - "type": "object", - "properties": { - "treeId": { - "type": "string", - "description": "The treeId of the GC that the node belongs to." - }, - "version": { - "type": "string", - "description": "The version of the GC tree that the node belongs to." - }, - "nodeId": { - "type": "string", - "description": "The configId of the node." - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "deviceGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "tasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - }, - "delete": { - "summary": "Removes node(s) from a compliance plan", - "description": "Removes new node(s) from an already existing compliance plan", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.removeNodesFromCompliancePlan", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": [ - "Successfully added node(s) to compliance plan" - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "nodeIds": { - "title": "nodeIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plans/run": { - "post": { - "summary": "Runs a compliance plan", - "description": "This API call will create WF job that will execute the compliance plan", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runCompliancePlan", - "responses": { - "200": { - "description": "The details of the plan instance that was created.", - "content": { - "application/json": { - "schema": { - "title": "response", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plan_instances": { - "put": { - "summary": "Update properties of a compliance plan instance", - "description": "Update properties of the specified compliance plan instance", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateCompliancePlanInstance", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Compliance Run Report updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "instanceId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "type": "string", - "examples": ["Compliance plan instance description"] - } - } - } - } - } - } - } - } - } - }, - "/automation-studio/templates": { - "get": { - "summary": "Gets a page of template documents.", - "description": "Gets a page of template documents.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - } - }, - { - "name": "exclude-project-members", - "in": "query", - "description": "Flag which removes workflows from the results which are members of a project", - "required": false, - "schema": { - "type": "boolean", - "description": "Flag which removes workflows from the results which are members of a project" - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "in", - "in": "query", - "description": "Search for fields exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "not-in", - "in": "query", - "description": "Search for fields not exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "equals", - "in": "query", - "description": "Returns results where the specified fields exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string" - } - }, - { - "name": "contains", - "in": "query", - "description": "Returns results where the specified fields contain the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields contain the given match string(s).", - "type": "string" - } - }, - { - "name": "starts-with", - "in": "query", - "description": "Returns results where the specified fields start with the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string" - } - }, - { - "name": "ends-with", - "in": "query", - "description": "Returns results where the specified fields end in the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.getTemplates", - "responses": { - "200": { - "description": "Results for the given search parameters.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_template" - } - }, - "total": { - "type": "integer", - "description": "Total number of documents matching the given query parameters." - }, - "start": { - "type": "integer", - "description": "Search index of first document in the items array." - }, - "end": { - "type": "integer", - "description": "Search index of the last document in the items array." - }, - "count": { - "type": "integer", - "description": "Length of the items array." - }, - "next": { - "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "previous": { - "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Creates a new template document.", - "description": "Creates a new template document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.createTemplate", - "responses": { - "200": { - "description": "Created template and associated edit URI.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "description": "Created template and associated edit URI.", - "properties": { - "created": { - "$ref": "#/components/schemas/automation-studio_template" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the newly created template." - } - }, - "required": ["created", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "$ref": "#/components/schemas/automation-studio_template" - } - } - } - } - } - } - } - }, - "/automation-studio/templates/{id}": { - "get": { - "summary": "Gets a single template document.", - "description": "Gets a single template document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ObjectId specifying a template entity.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "ObjectId specifying a template entity." - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - } - ], - "operationId": "AutomationStudio.getTemplate", - "responses": { - "200": { - "description": "Transformed data.", - "content": { - "application/json": { - "schema": { - "title": "output", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Deletes a template document.", - "description": "Deletes a template document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Template id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Template id." - } - } - ], - "operationId": "AutomationStudio.deleteTemplate", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Message denoting the status of the delete operation." - } - }, - "required": ["message"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Replaces a template document.", - "description": "Replaces a template document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Template id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Template id." - } - } - ], - "operationId": "AutomationStudio.updateTemplate", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "updated": { - "$ref": "#/components/schemas/automation-studio_template" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the updated template." - } - }, - "required": ["updated", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "update": { - "$ref": "#/components/schemas/automation-studio_templateUpdate" - } - } - } - } - } - } - } - }, - "/automation-studio/templates/import": { - "post": { - "summary": "Imports a new template document.", - "description": "Imports a new template document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.importTemplates", - "responses": { - "200": { - "description": "Results from each individual import operation.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "imported": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Status flag denoting the success (true) or failure (false) of the template's import operation." - }, - "message": { - "type": "string", - "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." - }, - "original": { - "$ref": "#/components/schemas/automation-studio_templateImport" - }, - "created": { - "description": "The imported template as it exists after being imported.", - "oneOf": [ - { - "$ref": "#/components/schemas/automation-studio_template" - }, - { - "type": "null" - } - ] - }, - "edit": { - "description": "URI to the edit page for the imported template.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "status", - "message", - "original", - "created", - "edit" - ] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "templates": { - "title": "templates", - "description": "Array of template documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a template's name is already used in the templates collection, it will be renamed with a numeric suffix.", - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_templateImport" - } - } - } - } - } - } - } - } - }, - "/automation-studio/templates/{id}/export": { - "get": { - "summary": "Exports a template document.", - "description": "Exports a template document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Template id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Template id." - } - } - ], - "operationId": "AutomationStudio.exportTemplate", - "responses": { - "200": { - "description": "Exported representation of the template.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_templateImport" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/json-forms/method-options": { - "get": { - "summary": "Get all available rest calls in IAP.", - "description": "Get all available rest calls in IAP.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.getMethodOptions", - "responses": { - "200": { - "description": "List of all rest calls available in the system.", - "content": { - "application/json": { - "schema": { - "title": "calls", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "getTemplate", - "createTemplate", - "importTemplates", - "exportTemplate" - ] - }, - "sourceType": { - "type": "string", - "examples": [ - "AutomationStudio", - "ConfigurationManager", - "MOP" - ] - }, - "path": { - "type": "string", - "examples": [ - "/templates/:id", - "/createTemplate", - "/listAnalyticTemplates" - ] - }, - "verb": { - "type": "string", - "enum": ["GET", "POST"] - }, - "origin": { - "type": "string", - "examples": [ - "/automation-studio", - "/mop", - "/validate-form/:id" - ] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AutomationStudio.admin"], - "CookieAuth": ["AutomationStudio.admin"], - "BasicAuth": ["AutomationStudio.admin"] - } - ], - "deprecated": false - } - }, - "/automation-studio/apps/list": { - "get": { - "summary": "Get a list of all the apps and adapters", - "description": "Get all apps and adapters.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.getAppsAndAdapters", - "responses": { - "200": { - "description": "List of all apps and adapters.", - "content": { - "application/json": { - "schema": { - "title": "apps_list", - "type": "array", - "items": { - "type": "object", - "examples": [ - { - "id": "@itential/app-admin_essentials", - "type": "UI", - "name": "AdminEssentials" - }, - { - "id": "@itential/app-automation_studio", - "type": "Application", - "name": "AutomationStudio" - }, - { - "id": "@itential/app-configuration_manager", - "type": "Application", - "name": "ConfigurationManager" - }, - { - "id": "@itential/app-ag_manager", - "type": "Application", - "name": "AGManager" - }, - { - "id": "@itential/app-form_builder", - "type": "Application", - "name": "FormBuilder" - } - ] - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/workflows": { - "get": { - "summary": "Gets a page of workflow documents.", - "description": "Gets a page of workflow documents.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - } - }, - { - "name": "exclude-project-members", - "in": "query", - "description": "Flag which removes workflows from the results which are members of a project", - "required": false, - "schema": { - "type": "boolean", - "description": "Flag which removes workflows from the results which are members of a project" - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "expand", - "in": "query", - "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", - "required": false, - "schema": { - "type": "string", - "title": "List of fields to get expanded data", - "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", - "examples": ["created_by,user,owner"] - } - }, - { - "name": "in", - "in": "query", - "description": "Search for fields exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string", - "examples": [ - "in[name]=my-workflow,or-this-workflow&in[type]=automation" - ] - } - }, - { - "name": "not-in", - "in": "query", - "description": "Search for fields not exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string", - "examples": ["not-in[name]=my-workflow,not-this-workflow"] - } - }, - { - "name": "equals", - "in": "query", - "description": "Returns results where the specified fields exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string", - "examples": ["equals[name]=my-workflow"] - } - }, - { - "name": "contains", - "in": "query", - "description": "Returns results where the specified fields contain the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields contain the given match string(s).", - "type": "string", - "examples": ["contains[name]=workflow"] - } - }, - { - "name": "starts-with", - "in": "query", - "description": "Returns results where the specified fields start with the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string", - "examples": ["starts-with[name]=my-"] - } - }, - { - "name": "ends-with", - "in": "query", - "description": "Returns results where the specified fields end in the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string", - "examples": ["ends-with[name]=-workflow"] - } - }, - { - "name": "task-equals", - "in": "query", - "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", - "type": "string", - "examples": ["task-equals[app]=WorkFlowEngine"] - } - } - ], - "operationId": "AutomationStudio.getWorkflows", - "responses": { - "200": { - "description": "Results for the given search parameters.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_workflowDocument" - } - }, - "total": { - "type": "integer", - "description": "Total number of documents matching the given query parameters." - }, - "start": { - "type": "integer", - "description": "Search index of first document in the items array." - }, - "end": { - "type": "integer", - "description": "Search index of the last document in the items array." - }, - "count": { - "type": "integer", - "description": "Length of the items array." - }, - "limit": { - "type": "integer", - "description": "Number of results to return. Used for pagination." - }, - "next": { - "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "previous": { - "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/workflows/detailed/{name}": { - "get": { - "summary": "Get Details of a Workflow", - "description": "Get the details of a Workflow by Workflow name.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow to get Workflow details.", - "required": true, - "schema": { - "type": "string", - "title": "name" - } - } - ], - "operationId": "AutomationStudio.getWorkflowDetailedByName", - "responses": { - "200": { - "description": "Workflow details matching the Workflow name.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_workflowDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/automations": { - "post": { - "summary": "Creates a new workflow document.", - "description": "Creates a new workflow document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.createAutomation", - "responses": { - "200": { - "description": "Created workflow and associated edit URI.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "description": "Created workflow and associated edit URI.", - "properties": { - "created": { - "$ref": "#/components/schemas/automation-studio_automation" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the newly created workflow." - } - }, - "required": ["created", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "automation": { - "$ref": "#/components/schemas/automation-studio_automation" - } - } - } - } - } - } - } - }, - "/automation-studio/automations/{id}": { - "put": { - "summary": "Replaces a workflow document.", - "description": "Replaces a workflow document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Workflow id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Workflow id." - } - } - ], - "operationId": "AutomationStudio.updateAutomation", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "updated": { - "$ref": "#/components/schemas/automation-studio_automation" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the updated workflow." - } - }, - "required": ["updated", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "update": { - "$ref": "#/components/schemas/automation-studio_automationUpdate" - } - } - } - } - } - } - } - }, - "/automation-studio/automations/import": { - "post": { - "summary": "Imports a new workflow document.", - "description": "Imports a new workflow document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.importAutomations", - "responses": { - "200": { - "description": "Results from each individual import operation.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "imported": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Status flag denoting the success (true) or failure (false) of the workflow's import operation." - }, - "message": { - "type": "string", - "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." - }, - "original": { - "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" - }, - "created": { - "description": "The imported workflow as it exists after being imported.", - "oneOf": [ - { - "$ref": "#/components/schemas/automation-studio_workflowDocument" - }, - { - "type": "null" - } - ] - }, - "edit": { - "description": "URI to the edit page for the imported workflow.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "status", - "message", - "original", - "created", - "edit" - ] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "automations": { - "title": "automations", - "description": "Array of workflow documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'.", - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" - } - } - } - } - } - } - } - } - }, - "/automation-studio/component-groups": { - "get": { - "summary": "Gets a page of component group documents.", - "description": "Gets a page of component group documents.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "in", - "in": "query", - "description": "Search for fields exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "not-in", - "in": "query", - "description": "Search for fields not exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "equals", - "in": "query", - "description": "Returns results where the specified fields exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string" - } - }, - { - "name": "contains", - "in": "query", - "description": "Returns results where the specified fields contain the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields contain the given match string(s).", - "type": "string" - } - }, - { - "name": "starts-with", - "in": "query", - "description": "Returns results where the specified fields start with the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string" - } - }, - { - "name": "ends-with", - "in": "query", - "description": "Returns results where the specified fields end in the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.getComponentGroups", - "responses": { - "200": { - "description": "Results for the given search parameters.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_componentGroup" - } - }, - "total": { - "type": "integer", - "description": "Total number of documents matching the given query parameters.", - "examples": [100] - }, - "start": { - "type": "integer", - "description": "Search index of first document in the items array.", - "examples": [0] - }, - "end": { - "type": "integer", - "description": "Search index of the last document in the items array.", - "examples": [100] - }, - "count": { - "type": "integer", - "description": "Length of the items array.", - "examples": [100] - }, - "next": { - "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "previous": { - "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Creates a new component group document.", - "description": "Creates a new component group document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.createComponentGroup", - "responses": { - "200": { - "description": "Created component group and associated edit URI.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "description": "Created component group and associated edit URI.", - "properties": { - "created": { - "$ref": "#/components/schemas/automation-studio_componentGroup" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the newly created component group." - } - }, - "required": ["created", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "componentGroup": { - "$ref": "#/components/schemas/automation-studio_componentGroup" - } - } - } - } - } - } - } - }, - "/automation-studio/component-groups/{id}": { - "get": { - "summary": "Gets a single component group document.", - "description": "Gets a single component group document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ObjectId specifying a component group entity.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "ObjectId specifying a component group entity." - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - } - ], - "operationId": "AutomationStudio.getComponentGroup", - "responses": { - "200": { - "description": "Transformed data.", - "content": { - "application/json": { - "schema": { - "title": "output", - "type": "object", - "examples": [ - { - "_id": "67d863a07620432ed58f7964", - "name": "Automation Studio", - "description": "", - "gbacRead": [], - "gbacWrite": [], - "members": [ - { - "path": ["addComponentsToProject"], - "ref": "2c27f941-aa37-42b2-9ecf-d0398676745d", - "sourceCollection": "workflows", - "type": "component", - "name": "addComponentsToProject" - }, - { - "path": ["createProject"], - "ref": "887d1e2d-3641-41f4-9f93-40bc0f134b5b", - "sourceCollection": "workflows", - "type": "component", - "name": "createProject" - } - ] - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Deletes a component group document.", - "description": "Deletes a component group document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Component group id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Component group id." - } - } - ], - "operationId": "AutomationStudio.deleteComponentGroup", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Message denoting the status of the delete operation.", - "examples": [ - "Deleted componentGroup 67d32e60a402649caa29a006" - ] - } - }, - "required": ["message"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Replaces a component group document.", - "description": "Replaces a component group document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Component group id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Component group id." - } - } - ], - "operationId": "AutomationStudio.updateComponentGroup", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "updated": { - "$ref": "#/components/schemas/automation-studio_componentGroup" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the updated component group." - } - }, - "required": ["updated", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "update": { - "$ref": "#/components/schemas/automation-studio_componentGroupUpdate" - } - } - } - } - } - } - } - }, - "/automation-studio/component-groups/import": { - "post": { - "summary": "Imports a new component group document.", - "description": "Imports a new component group document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.importComponentGroups", - "responses": { - "200": { - "description": "Results from each individual import operation.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "imported": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Status flag denoting the success (true) or failure (false) of the component group's import operation." - }, - "message": { - "type": "string", - "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." - }, - "original": { - "$ref": "#/components/schemas/automation-studio_componentGroupImport" - }, - "created": { - "description": "The imported component group as it exists after being imported.", - "oneOf": [ - { - "$ref": "#/components/schemas/automation-studio_componentGroup" - }, - { - "type": "null" - } - ] - }, - "edit": { - "description": "URI to the edit page for the imported component group.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "status", - "message", - "original", - "created", - "edit" - ] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "componentGroups": { - "title": "componentGroups", - "description": "Array of component group documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a component group's name is already used in the component groups collection, it will be renamed with a numeric suffix.", - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_componentGroupImport" - } - } - } - } - } - } - } - } - }, - "/automation-studio/workflows/validate": { - "post": { - "summary": "Validate a workflow", - "description": "Validate a workflow, and return the resulting errors and warnings arrays.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.validateWorkflow", - "responses": { - "200": { - "description": "Errors and warnings output from the validation process", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "validationResult", - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object" - } - }, - "warnings": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread", - "AutomationStudio.apiwrite" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread", - "AutomationStudio.apiwrite" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread", - "AutomationStudio.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" - } - } - } - } - } - } - } - }, - "/automation-studio/references-to": { - "get": { - "summary": "Gets references to a particular document.", - "description": "Gets references to a particular document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "target-type", - "in": "query", - "description": "Type of document to search for references to.", - "required": false, - "schema": { - "type": "string", - "description": "Type of document to search for references to." - } - }, - { - "name": "target-identifiers", - "in": "query", - "description": "IDs of the components to search for references to.", - "required": false, - "schema": { - "type": "string", - "description": "IDs of the components to search for references to." - } - }, - { - "name": "referrer-type", - "in": "query", - "description": "Type of documents to search for references in.", - "required": false, - "schema": { - "type": "string", - "description": "Type of documents to search for references in." - } - } - ], - "operationId": "AutomationStudio.getReferencesTo", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "referencesByTarget": { - "type": "array", - "items": { - "type": "object", - "properties": { - "target": { - "type": "object", - "properties": { - "identifer": { - "type": "string", - "examples": [ - "940a1b4f-399a-44df-a42e-d37da51c7637", - "5eb596edf955d0e5288f84ef" - ] - }, - "type": { - "type": "string", - "enum": [ - "workflow", - "json-form", - "transformation", - "template", - "command-template", - "analytic-template", - "form" - ] - } - } - }, - "totalReferencingInstances": { - "type": "number" - }, - "totalReferences": { - "type": "number" - }, - "references": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "workflow", - "json-form", - "transformation", - "template", - "command-template", - "analytic-template", - "form" - ] - }, - "_id": { - "type": "string", - "examples": [ - "940a1b4f-399a-44df-a42e-d37da51c7637", - "5eb596edf955d0e5288f84ef" - ] - }, - "name": { - "type": "string" - }, - "referencePaths": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": true - } - }, - "/automation-studio/locations/{location}/packages/{pckg}/tasks/{method}": { - "get": { - "summary": "Get Task Details", - "description": "Get the detailed information model for a task", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "location", - "in": "path", - "description": "Location: Application, Broker, Adapter", - "required": true, - "schema": { - "type": "string", - "title": "location" - } - }, - { - "name": "pckg", - "in": "path", - "description": "Package name", - "required": true, - "schema": { - "type": "string", - "title": "pckg", - "examples": ["WorkFlowEngine"] - } - }, - { - "name": "method", - "in": "path", - "description": "Method name", - "required": true, - "schema": { - "type": "string", - "title": "method", - "examples": ["query", "merge"] - } - } - ], - "operationId": "AutomationStudio.getTaskDetails", - "responses": { - "200": { - "description": "Detailed information on a task", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_taskDetails" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] - } - ], - "deprecated": false - } - }, - "/automation-studio/multipleTaskDetails": { - "post": { - "summary": "Get Task Details", - "description": "Get the detailed information model for a task", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.getMultipleTaskDetails", - "responses": { - "200": { - "description": "Detailed information on a task", - "content": { - "application/json": { - "schema": { - "type": "array", - "title": "taskDetails", - "items": { - "$ref": "#/components/schemas/automation-studio_taskDetails" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "inputsArray": { - "type": "array", - "title": "inputsArray", - "items": { - "type": "object", - "properties": { - "location": { - "title": "location", - "type": "string", - "description": "Location: Application, Broker, Adapter", - "examples": ["Application", "Adapter", "Broker"] - }, - "pckg": { - "title": "pckg", - "type": "string", - "description": "Package name", - "examples": ["WorkFlowEngine"] - }, - "method": { - "title": "method", - "type": "string", - "description": "Method name", - "examples": ["query", "merge"] - } - } - } - } - } - } - } - } - } - } - }, - "/automation-studio/projects": { - "get": { - "summary": "Search projects", - "description": "Search projects", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.getProjects", - "responses": { - "200": { - "description": "Projects", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully retrieved projects"] - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - }, - "metadata": { - "type": "object", - "properties": { - "skip": { - "type": "number" - }, - "limit": { - "type": "number" - }, - "total": { - "type": "number" - }, - "previousPageSkip": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - } - ] - }, - "nextPageSkip": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - } - ] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Creates a new project", - "description": "Creates a new project", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.createProject", - "responses": { - "200": { - "description": "Create result", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully created project"] - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "createData", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_projects-create-data" - } - } - } - } - } - }, - "/automation-studio/projects/{projectId}": { - "get": { - "summary": "Gets a single Project", - "description": "Gets a single Project", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.getProject", - "responses": { - "200": { - "description": "API response body", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully retrieved project"] - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Updates an existing project", - "description": "Updates an existing project", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier, either an ObjectId or an IID", - "required": true, - "schema": { - "$ref": "#/components/schemas/automation-studio_projects-http-id" - } - } - ], - "operationId": "AutomationStudio.updateProject", - "responses": { - "200": { - "description": "Update result", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "updateData", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_projects-update-data" - } - } - } - } - } - }, - "/automation-studio/projects/{id}/export": { - "get": { - "summary": "Exports a project document as a JSON document, inlining all related documents into its components array", - "description": "Exports a project document as a JSON document, inlining all related documents into its components array", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.exportProject", - "responses": { - "200": { - "description": "Exported project", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully exported project"] - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-export-v1" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/projects/import": { - "post": { - "summary": "Imports a project document from a JSON document", - "description": "Imports a project document from a JSON document", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.importProject", - "responses": { - "200": { - "description": "Import result", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "properties": { - "project": { - "$ref": "#/components/schemas/automation-studio_projects-export-v1" - }, - "conflictMode": { - "type": "string", - "enum": ["overwrite", "insert-new"] - }, - "skipReferenceValidation": { - "type": "boolean", - "description": "If true, validations will not be run against references.", - "default": false - }, - "assignNewReferences": { - "type": "boolean", - "description": "This being true would indicate that the imported project is part of a clone action.", - "default": false - } - } - } - } - } - } - } - }, - "/automation-studio/discoverReferences": { - "post": { - "summary": "Discover referenced resources", - "description": "Finds all resource references from a set of specified resource identifiers", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.discoverReferences", - "responses": { - "200": { - "description": "References", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_resource-ref-http" - } - } - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer", - "AutomationStudio.engineering" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer", - "AutomationStudio.engineering" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer", - "AutomationStudio.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "properties": { - "resourceIdentifiers": { - "type": "array", - "description": "Array of resource identifiers to find references for.", - "items": { - "type": "object", - "properties": { - "resourceType": { - "type": "string", - "description": "The type of the resource." - }, - "resourcePointer": { - "type": "string", - "description": "The pointer to the identifier value in the resource object." - }, - "resourceId": { - "type": "string", - "description": "The value of the identifier in the resource object." - }, - "recursionDepth": { - "type": "integer", - "description": "Specifies the number of hierarchical levels to traverse when discovering references for this component. If omitted, the search on this component will be fully recursive." - } - } - } - }, - "recursive": { - "type": "boolean", - "description": "If true, recursively looks up resources on all referenced resources.", - "default": false - }, - "includeResources": { - "type": "boolean", - "description": "If true, include the full resource document in each resource reference object.", - "default": false - }, - "ignore": { - "type": "object", - "description": "An object of resource types to directions that will not be included in discovery. Cannot be used with include.", - "additionalProperties": { - "enum": ["up", "down", "all"] - } - }, - "include": { - "type": "object", - "description": "An object of resource types and directions to be included in discovery. Cannot be used with ignore.", - "additionalProperties": { - "enum": ["up", "down", "all"] - } - }, - "removeCycles": { - "type": "boolean", - "description": "If true, removes all cyclic relationships from the list of resource references.", - "default": false - } - } - } - } - } - } - } - }, - "/automation-studio/projects/{id}": { - "delete": { - "summary": "Delete a project and any components it contains", - "description": "Delete a project and any components it contains", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Project ID", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Project ID" - } - } - ], - "operationId": "AutomationStudio.deleteProject", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Message denoting the status of the delete operation." - } - }, - "required": ["message"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/projects/{projectId}/components/{componentId}": { - "delete": { - "summary": "Remove a component from a project", - "description": "Remove a component from a project", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string", - "description": "Project identifier" - } - }, - { - "name": "componentId", - "in": "path", - "description": "Component identifier", - "required": true, - "schema": { - "title": "componentId", - "type": "number", - "description": "Component identifier" - } - } - ], - "operationId": "AutomationStudio.removeComponentFromProject", - "responses": { - "200": { - "description": "Response object", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Message denoting the status of the delete operation" - }, - "data": { - "$ref": "#/components/schemas/automation-studio_projects-http" - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "description": "Options designating removal mode", - "properties": { - "mode": { - "type": "string", - "enum": ["delete", "move"] - } - } - } - } - } - } - } - } - } - }, - "/automation-studio/projects/{projectId}/components/add": { - "post": { - "summary": "Add one or more components to Project", - "description": "Add one or more components to Project", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.addComponentsToProject", - "responses": { - "200": { - "description": "Updated project", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - }, - "metadata": { - "type": "object", - "properties": { - "newComponents": { - "type": "array", - "description": "Components added" - }, - "failedComponents": { - "type": "array", - "description": "Components failed to add" - }, - "idMap": { - "type": "array", - "description": "Id map for original and cloned component", - "examples": [ - [ - { - "original": "1a643151-459b-4a4a-be91-623536b65df3", - "clone": "8696f332-030b-4c2a-8b1b-95844cbb6aea" - } - ] - ] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "required": ["components"], - "properties": { - "components": { - "$ref": "#/components/schemas/automation-studio_projects-common_components" - }, - "mode": { - "type": "string", - "enum": ["move", "copy"] - } - } - } - } - } - } - } - }, - "/automation-studio/projects/{projectId}/thumbnail": { - "put": { - "summary": "Set a project's thumbnail image", - "description": "Set a project's thumbnail image", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.uploadProjectThumbnail", - "responses": { - "200": { - "description": "Updated project", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_project-thumbnails-update-data" - } - } - } - } - }, - "get": { - "summary": "Gets a Project's thumbnail", - "description": "Gets a Project's thumbnail. Returns data as a base64 encoded string of binary data.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.getProjectThumbnail", - "responses": { - "200": { - "description": "API response body", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully retrieved project thumbnail"] - }, - "data": { - "type": "object", - "properties": { - "image": { - "description": "Base64 encoded binary contents of the image file", - "type": "string", - "examples": [""] - }, - "backgroundColor": { - "description": "Hex value of thumbnail background color", - "type": "string", - "examples": ["#FFFFFF"] - }, - "metadata": { - "type": "object" - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] - } - ], - "deprecated": false - } - }, - "/tags/get": { - "post": { - "summary": "Get tag details given an id", - "description": "Get details and results for a single tag given that tags id.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.get", - "responses": { - "200": { - "description": "Tag details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "title": "id", - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - } - } - } - } - } - } - } - }, - "/tags/find": { - "post": { - "summary": "Find tags by name", - "description": "Find a list of tags given a name.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.find", - "responses": { - "200": { - "description": "Tag details", - "content": { - "application/json": { - "schema": { - "title": "details", - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - } - } - } - } - } - } - } - }, - "/tags/all": { - "get": { - "summary": "Get all tags", - "description": "Get a list of all tags.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.all", - "responses": { - "200": { - "description": "Get all tags", - "content": { - "application/json": { - "schema": { - "title": "details", - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false - } - }, - "/tags/create": { - "post": { - "summary": "Create new tag", - "description": "Create a new tag.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.create", - "responses": { - "200": { - "description": "New tag data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/tags_tagDocument_tagName" - }, - "description": { - "$ref": "#/components/schemas/tags_tagDocument_tagDescription" - } - } - } - } - } - } - } - } - } - }, - "/tags/createTags": { - "post": { - "summary": "Create many new tags", - "description": "Create multiple new tags at once.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.createTags", - "responses": { - "200": { - "description": "New tag data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/tags_tagDocument_tagName" - }, - "description": { - "$ref": "#/components/schemas/tags_tagDocument_tagDescription" - } - } - } - } - } - } - } - } - } - } - }, - "/tags/createReference": { - "post": { - "summary": "Reference a tag to a peice of content", - "description": "Create reference for tag that links it to a peice of content. This allows for content to find the tags related to it.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.createReference", - "responses": { - "200": { - "description": "New Reference Tag data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_referenceObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], - "CookieAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], - "BasicAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "tag_id": { - "$ref": "#/components/schemas/tags_tagDocument_tagId" - }, - "ref_id": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefId" - }, - "type": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefType" - } - } - } - } - } - } - } - } - } - }, - "/tags/handleReferences": { - "post": { - "summary": "Create/Update references for tags", - "description": "Create/Update references for multiple tags to a peice of content", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.handleReferences", - "responses": { - "200": { - "description": "If tag reference updates were successful.", - "content": { - "application/json": { - "schema": { - "title": "success", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], - "CookieAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], - "BasicAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "tag_ids": { - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_tagId" - } - }, - "ref_id": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefId" - }, - "type": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefType" - } - } - } - } - } - } - } - } - } - }, - "/tags/getTagsByReference": { - "post": { - "summary": "Get Tags by content id", - "description": "Get tags for a piece of content by the content id", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.getTagsByReference", - "responses": { - "200": { - "description": "Array of tags related to reference id", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_referenceObject" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], - "CookieAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], - "BasicAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "ref_id": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefId" - } - } - } - } - } - } - } - } - } - }, - "/tags/getTagReferences": { - "post": { - "summary": "Get Tag refs by content ids", - "description": "Get tag references from multiple content ids.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.getTagReferences", - "responses": { - "200": { - "description": "Array of tags related to content ids", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_referenceObject" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], - "CookieAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], - "BasicAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "ref_id": { - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefId" - } - } - } - } - } - } - } - } - } - } - }, - "/tags/update": { - "post": { - "summary": "Updating existing tag", - "description": "Updating existing tag", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.update", - "responses": { - "200": { - "description": "Updated tag data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tag": { - "type": "object", - "title": "tag", - "properties": { - "_id": { - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - }, - "description": { - "type": "string", - "examples": ["Descriptions can be empty"] - }, - "name": { - "type": "string", - "examples": ["My Tag"] - } - } - } - } - } - } - } - } - } - }, - "/tags/duplicate": { - "post": { - "summary": "Clone existing tag", - "description": "Duplicate existing tag by cloning it and changing the name.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.duplicate", - "responses": { - "200": { - "description": "Results from duplicated tag", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "_id": { - "title": "_id", - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - } - } - } - } - } - } - } - }, - "/tags/delete": { - "post": { - "summary": "Delete existing tag", - "description": "Delete an existing tag.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.delete", - "responses": { - "200": { - "description": "Results from deleted tag", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "_id": { - "title": "_id", - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - } - } - } - } - } - } - } - }, - "/workflow_engine/activate": { - "post": { - "summary": "Activate Task Worker", - "description": "Activate Task Worker", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.activate", - "responses": { - "200": { - "description": "Status flag of activation", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/jobWorker/activate": { - "post": { - "summary": "Activate the job worker", - "description": "Allow new parent jobs to be created", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.activateJobWorker", - "responses": { - "200": { - "description": "Status flag of activation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/deactivate": { - "post": { - "summary": "Deactivate Task Worker", - "description": "Deactivate Task Worker", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.deactivate", - "responses": { - "200": { - "description": "Status flag of deactivation", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/jobWorker/deactivate": { - "post": { - "summary": "Deactivate the job worker", - "description": "Disallow new parent jobs from being created", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.deactivateJobWorker", - "responses": { - "200": { - "description": "Status flag of deactivation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/diffToHTML": { - "post": { - "summary": "diff to HTML", - "description": "Difference between two values in HTML response", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.diffToHTML", - "responses": { - "200": { - "description": "HTML difference between value1 and value2", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string", - "examples": ["config configuration \n 3 222 \n was is "] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "label1": { - "title": "label1", - "type": "string", - "examples": ["pre"] - }, - "value1": { - "title": "value1", - "type": "string", - "examples": [ - "config\n stuff \nline 3 \ntoday was a good day" - ] - }, - "label2": { - "title": "label2", - "type": "string", - "examples": ["post"] - }, - "value2": { - "title": "value2", - "type": "string", - "examples": [ - "configuration\n stuff \nline 222 \ntoday is a good day" - ] - } - } - } - } - } - } - } - }, - "/workflow_engine/jobs/metrics": { - "get": { - "summary": "Get aggregate job metrics", - "description": "Search aggregate job metrics with options", - "tags": ["workflow_engine"], - "parameters": [ - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_order" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_sort" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" - } - }, - { - "name": "greaterThanEquals", - "in": "query", - "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", - "required": false, - "schema": { - "type": "integer", - "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", - "examples": [1617383798468, 1617383798460] - } - }, - { - "name": "greaterThanEqualsField", - "in": "query", - "description": "Date field to compare.", - "required": false, - "schema": { - "type": "string", - "description": "Date field to compare.", - "examples": ["metrics.startDate"], - "enum": ["metrics.startDate"] - } - }, - { - "name": "contains", - "in": "query", - "description": "String value to compare with containsField.", - "required": false, - "schema": { - "type": "string", - "description": "String value to compare with containsField.", - "examples": ["exampleName"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "Field to compare with contains value.", - "required": false, - "schema": { - "type": "string", - "description": "Field to compare with contains value.", - "examples": ["workflow.name"], - "enum": ["workflow.name"] - } - } - ], - "operationId": "WorkFlowEngine.getJobMetrics", - "responses": { - "200": { - "description": "metrics", - "content": { - "application/json": { - "schema": { - "title": "metrics", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow_engine_taskMetricsDocument" - } - }, - "skip": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" - }, - "limit": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" - }, - "total": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/tasks/metrics": { - "get": { - "summary": "Get aggregate task metrics", - "description": "Search aggregate task metrics with options", - "tags": ["workflow_engine"], - "parameters": [ - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_order" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_sort" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" - } - }, - { - "name": "greaterThanEquals", - "in": "query", - "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", - "required": false, - "schema": { - "type": "integer", - "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", - "examples": [1617383798468, 1617383798460] - } - }, - { - "name": "greaterThanEqualsField", - "in": "query", - "description": "Date field to compare.", - "required": false, - "schema": { - "type": "string", - "description": "Date field to compare.", - "examples": ["metrics.startDate"], - "enum": ["metrics.startDate"] - } - }, - { - "name": "equals", - "in": "query", - "description": "String value to compare with equalsField.", - "required": false, - "schema": { - "type": "string", - "description": "String value to compare with equalsField.", - "examples": ["exampleName"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "Field to compare with equals value.", - "required": false, - "schema": { - "type": "string", - "description": "Field to compare with equals value.", - "examples": ["workflow.name"], - "enum": ["workflow.name"] - } - } - ], - "operationId": "WorkFlowEngine.getTaskMetrics", - "responses": { - "200": { - "description": "metrics", - "content": { - "application/json": { - "schema": { - "title": "metrics", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow_engine_jobMetricsDocument" - } - }, - "skip": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" - }, - "limit": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" - }, - "total": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/workers/status": { - "get": { - "summary": "Get the current and future states of the task and job workers", - "description": "Get the current and future states of the task and job workers", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.getWorkerStatuses", - "responses": { - "200": { - "description": "Statuses of the job and task worker", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "jobWorker": { - "type": "object", - "properties": { - "running": { - "type": "boolean", - "description": "Whether the worker is currently running" - }, - "clusterValue": { - "type": "string", - "enum": ["enabled", "disabled", "not defined"], - "description": "Whether the service_config was set to enable this worker" - }, - "localValue": { - "type": "string", - "enum": ["enabled", "disabled", "not defined"], - "description": "Whether the properties.json was set to enable this worker" - }, - "startupValue": { - "type": "boolean", - "description": "Whether the clusterValue and localValue combined allow the worker to start" - } - } - }, - "taskWorker": { - "type": "object", - "properties": { - "running": { - "type": "boolean", - "description": "Whether the worker is currently running" - }, - "clusterValue": { - "type": "string", - "enum": ["enabled", "disabled", "not defined"], - "description": "Whether the service_config was set to enable this worker" - }, - "localValue": { - "type": "string", - "enum": ["enabled", "disabled", "not defined"], - "description": "Whether the properties.json was set to enable this worker" - }, - "startupValue": { - "type": "boolean", - "description": "Whether the clusterValue and localValue combined allow the worker to start" - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/active": { - "get": { - "summary": "Check Staterator State", - "description": "Check if Staterator is currently active", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.isActive", - "responses": { - "200": { - "description": "Active flag for Staterator", - "content": { - "application/json": { - "schema": { - "title": "state", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": true - } - }, - "/workflow_engine/query": { - "post": { - "summary": "Query Data Using 'json-query' Format", - "description": "Query data using a dot/bracket notation string and a matching key/value pair.", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.query", - "responses": { - "200": { - "description": "Returned data from the match query", - "content": { - "application/json": { - "schema": { - "title": "return_data", - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "object" - }, - { - "type": "array" - }, - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "examples": ["value"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "job_id": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_mongoObjectId" - }, - "pass_on_null": { - "title": "pass_on_null", - "type": "boolean" - }, - "query": { - "title": "query", - "type": "string", - "examples": ["name"] - }, - "obj": { - "title": "obj", - "type": "object", - "properties": {}, - "examples": [ - { - "name": "value" - } - ] - } - } - } - } - } - } - } - }, - "/workflow_engine/runEvaluationGroup": { - "post": { - "summary": "Evaluation", - "description": "Run a test evaluation.", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.runEvaluationGroup", - "responses": { - "200": { - "description": "Result of evaluation.", - "content": { - "application/json": { - "schema": { - "type": "boolean", - "title": "evaluation_group_value" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "evaluation_group": { - "title": "evaluation_group", - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_evaluationItem" - } - }, - "all_true_flag": { - "title": "all_true_flag", - "type": "boolean" - } - } - } - } - } - } - } - }, - "/workflow_engine/runEvaluationGroups": { - "post": { - "summary": "Evaluation Group", - "description": "Run a test evaluation group.", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.runEvaluationGroups", - "responses": { - "200": { - "description": "Result of evaluation.", - "content": { - "application/json": { - "schema": { - "type": "boolean", - "title": "return_value" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "evaluation_group": { - "title": "evaluation_group", - "type": "array", - "items": { - "type": "object", - "properties": { - "evaluations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_evaluationItem" - } - }, - "all_true_flag": { - "type": "boolean" - } - } - } - }, - "all_true_flag": { - "title": "all_true_flag", - "type": "boolean" - } - } - } - } - } - } - } - }, - "/json-forms/forms": { - "post": { - "summary": "Creates a Json Form", - "description": "Creates a new JSON form document with a unique name.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.createForm", - "responses": { - "200": { - "description": "document that was created from the request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["Device Form"] - }, - "description": { - "title": "description", - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "struct": { - "$ref": "#/components/schemas/json-forms_formStruct" - }, - "schema": { - "$ref": "#/components/schemas/json-forms_formSchema_container" - }, - "uiSchema": { - "$ref": "#/components/schemas/json-forms_formUISchema_container" - }, - "bindingSchema": { - "$ref": "#/components/schemas/json-forms_formBindingSchema_bindingSchema" - }, - "validationSchema": { - "$ref": "#/components/schemas/json-forms_formValidationSchema_validationSchema" - } - } - } - } - } - } - }, - "get": { - "summary": "Returns all forms", - "description": "Returns all JSON form documents that have previously been created.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.getForms", - "responses": { - "200": { - "description": "An array of form documents.", - "content": { - "application/json": { - "schema": { - "title": "forms", - "type": "array", - "items": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - }, - "examples": [ - [ - { - "id": "62bf2e8333385420ffe7bdd7", - "createdBy": "admin@pronoghorn", - "lastUpdatedBy": "admin@pronghorn", - "struct": { - "type": "object", - "description": "", - "items": [] - }, - "bindingSchema": {}, - "validationSchema": {}, - "tags": [], - "created": "2022-07-01T17:27:31.335Z", - "lastUpdated": "2022-07-01T17:27:31.335Z", - "name": "form-name", - "description": "", - "schema": { - "title": "form-name", - "description": "", - "type": "object", - "required": [], - "properties": {} - }, - "uiSchema": {}, - "version": "2022.1" - } - ] - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Deletes a forms", - "description": "Delete a list of JSON Forms from IAP.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.deleteForms", - "responses": { - "200": { - "description": "The status and number of delete forms.", - "content": { - "application/json": { - "schema": { - "title": "document", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "failure"] - }, - "n": { - "type": "integer" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ids": { - "title": "ids", - "type": "array", - "items": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - } - } - } - } - } - } - } - } - }, - "/json-forms/forms/{id}": { - "get": { - "summary": "Finds a form", - "description": "Finds a previously created JSON form, based on a supplied document ID.", - "tags": ["json-forms"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique name of the form", - "required": true, - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_formId" - } - } - ], - "operationId": "JsonForms.getFormById", - "responses": { - "200": { - "description": "document of requested form", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates a form", - "description": "Updates a previously created JSON form, based on a supplied document ID and an object of fields to update.", - "tags": ["json-forms"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the form.", - "required": true, - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_formId" - } - } - ], - "operationId": "JsonForms.updateForm", - "responses": { - "200": { - "description": "A response object containing the request status and a message", - "content": { - "application/json": { - "schema": { - "title": "document", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "failure"] - }, - "message": { - "type": "string", - "examples": ["Form updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - } - } - } - } - } - } - } - }, - "/json-forms/import/forms": { - "post": { - "summary": "Import form documents", - "description": "Insert form documents into the forms collection from a user supplied JSON document.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.importForms", - "responses": { - "200": { - "description": "Status of forms import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 forms imported successfully" - }, - "imported": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "message": { - "type": "string" - }, - "original": { - "$ref": "#/components/schemas/json-forms_formDocument_importResultReport" - }, - "created": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/json-forms_formDocument_importResultReport" - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "forms": { - "title": "forms", - "type": "array", - "items": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - } - } - } - } - } - } - } - } - }, - "/json-forms/validate-form/{id}": { - "post": { - "summary": "Validates form data against its schema", - "description": "Retrieves the JSON schema for a given form ID and validates the supplied form data again it.", - "tags": ["json-forms"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique ID of the form", - "required": true, - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_formId" - } - } - ], - "operationId": "JsonForms.validateForm", - "responses": { - "200": { - "description": "results from the form validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_validationResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "formData": { - "$ref": "#/components/schemas/json-forms_formDocument_formData" - } - } - } - } - } - } - } - }, - "/json-forms/validate-data": { - "post": { - "summary": "Validates data against a schema.", - "description": "Performs data validation, given a JSON schema and form data.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.validateData", - "responses": { - "200": { - "description": "results from the form validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_validationResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jsonSchema": { - "$ref": "#/components/schemas/json-forms_metaSchema" - }, - "data": { - "$ref": "#/components/schemas/json-forms_formDocument_formData" - } - } - } - } - } - } - } - }, - "/json-forms/yangToSchema": { - "post": { - "summary": "Converts YANG to JSON Schema.", - "description": "onverts a list of YANG inputs into JSON Schemas", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.yangToSchema", - "responses": { - "200": { - "description": "Yang inputs converted to JSON schema", - "content": { - "application/json": { - "schema": { - "title": "jsonSchema", - "type": "array", - "items": { - "type": "object" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "yangData": { - "title": "yang", - "type": "array", - "items": { - "type": "string", - "description": "Yang module data in string format", - "examples": [ - "module Test { list interface { key \"name\"; leaf name { type string; } } }" - ] - } - } - } - } - } - } - } - } - }, - "/json-forms/decode": { - "post": { - "summary": "Decodes an encoded JSON Schema.", - "description": "Decodes an encoded JSON Schema.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.decodeSchema", - "responses": { - "200": { - "description": "Decoded Json Schema", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jsonSchema": { - "title": "jsonSchema", - "type": "object" - } - } - } - } - } - } - } - }, - "/ag-manager/actions": { - "get": { - "summary": "Merge discovered actions from all IAG adapters", - "description": "Discovers all actions from inputed IAG adapters. This will restart this app and display a corresponding log message.", - "tags": ["ag-manager"], - "parameters": [], - "operationId": "AGManager.discoverAll", - "responses": { - "200": { - "description": "A pronghorn.json object.", - "content": { - "application/json": { - "schema": { - "title": "pronghornJson", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AGManager.admin", "AGManager.apiread"], - "CookieAuth": ["AGManager.admin", "AGManager.apiread"], - "BasicAuth": ["AGManager.admin", "AGManager.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskContinuation": { - "title": "Task Continuation", - "type": "boolean", - "default": true - } - } - } - } - } - } - }, - "delete": { - "summary": "Remove discovered actions from all IAG adapter", - "description": "Discovers all actions from all IAG adapters. This will restart this app and display a corresponding log message.", - "tags": ["ag-manager"], - "parameters": [], - "operationId": "AGManager.undiscoverAll", - "responses": { - "200": { - "description": "A pronghorn.json object.", - "content": { - "application/json": { - "schema": { - "title": "pronghornJson", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AGManager.admin", "AGManager.apiwrite"], - "CookieAuth": ["AGManager.admin", "AGManager.apiwrite"], - "BasicAuth": ["AGManager.admin", "AGManager.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskContinuation": { - "title": "Task Continuation", - "type": "boolean", - "default": true - } - } - } - } - } - } - } - }, - "/ag-manager/actions/{adapterId}": { - "get": { - "summary": "Discover actions on one IAG adapter", - "description": "Discovers all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.", - "tags": ["ag-manager"], - "parameters": [ - { - "name": "adapterId", - "in": "path", - "description": "Automation Gateway adapter ID.", - "required": true, - "schema": { - "title": "adapterId", - "type": "string" - } - } - ], - "operationId": "AGManager.discoverModules", - "responses": { - "200": { - "description": "A pronghorn.json object.", - "content": { - "application/json": { - "schema": { - "title": "pronghornJson", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AGManager.admin", "AGManager.apiread"], - "CookieAuth": ["AGManager.admin", "AGManager.apiread"], - "BasicAuth": ["AGManager.admin", "AGManager.apiread"] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Remove discovered actions from one IAG adapter", - "description": "Removes all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.", - "tags": ["ag-manager"], - "parameters": [ - { - "name": "adapterId", - "in": "path", - "description": "Automation Gateway adapter ID.", - "required": true, - "schema": { - "title": "adapterId", - "type": "string" - } - } - ], - "operationId": "AGManager.undiscoverModules", - "responses": { - "200": { - "description": "A pronghorn.json object.", - "content": { - "application/json": { - "schema": { - "title": "pronghornJson", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AGManager.admin", "AGManager.apiwrite"], - "CookieAuth": ["AGManager.admin", "AGManager.apiwrite"], - "BasicAuth": ["AGManager.admin", "AGManager.apiwrite"] - } - ], - "deprecated": false - } - }, - "/ag-manager/getClusterAdapters": { - "get": { - "summary": "Get all adapters in all clusters", - "description": "Get all adapters in all clusters", - "tags": ["ag-manager"], - "parameters": [], - "operationId": "AGManager.getClusterAdapters", - "responses": { - "200": { - "description": "A cluster adapter mapping object.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["AGManager.admin", "AGManager.apiread"], - "CookieAuth": ["AGManager.admin", "AGManager.apiread"], - "BasicAuth": ["AGManager.admin", "AGManager.apiread"] - } - ], - "deprecated": false - } - }, - "/workflow_builder/tasks/list": { - "get": { - "summary": "Get Tasks", - "description": "Get all Tasks.", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.getTasksList", - "responses": { - "200": { - "description": "List of all Tasks.", - "content": { - "application/json": { - "schema": { - "title": "task_list", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "location": { - "type": "string", - "enum": ["Application", "Adapter", "Broker"] - }, - "app": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "type": { - "type": "string", - "enum": ["automatic", "manual", "operation"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - } - } - }, - "deprecated": { - "type": "boolean" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false - } - }, - "/workflow_builder/getTaskDetails/{app}/{task}": { - "get": { - "summary": "Get Task Details", - "description": "Get a Task's details.", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "app", - "in": "path", - "description": "Application's name (export field in model)", - "required": true, - "schema": { - "title": "app", - "type": "string", - "examples": ["ConfigurationManager"] - } - }, - { - "name": "task", - "in": "path", - "description": "Task's id (hex)", - "required": true, - "schema": { - "title": "task", - "type": "string", - "pattern": "^[0-9a-f]{1,4}$" - } - } - ], - "operationId": "WorkflowBuilder.getTaskDetails", - "responses": { - "200": { - "description": "Detailed Task.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_anyTask" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false - } - }, - "/workflow_builder/workflows/schemas": { - "post": { - "summary": "Calculate incoming/outgoing schemas for the workflow", - "description": "calculate incoming/outgoing schemas for the workflow", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.getSchemas", - "responses": { - "200": { - "description": "Input/Output transformation schemas for the workflow", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": { - "inputSchema": { - "type": "object" - }, - "outputSchema": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - } - } - } - } - } - } - } - }, - "/workflow_builder/workflows/save": { - "post": { - "summary": "Add Workflow", - "description": "Add a Workflow to the database", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.saveWorkflow", - "responses": { - "200": { - "description": "The new Workflow with its data and ID.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - } - } - } - } - } - } - } - }, - "/workflow_builder/workflows/rename": { - "post": { - "summary": "Rename Workflow", - "description": "Rename a Workflow in the database", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.renameWorkflow", - "responses": { - "200": { - "description": "The renamed Workflow with its data and ID.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - }, - "newName": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - } - } - } - } - } - }, - "/workflow_builder/workflows/delete/{name}": { - "delete": { - "summary": "Delete Workflow", - "description": "Delete a Workflow from the database", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Workflow's name.", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.deleteWorkflow", - "responses": { - "200": { - "description": "Status of delete", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false - } - }, - "/workflow_builder/workflows/{name}/groups": { - "get": { - "summary": "List Groups for a Workflow", - "description": "List the groups that have access to a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.listWorkflowGroups", - "responses": { - "200": { - "description": "List of Groups", - "content": { - "application/json": { - "schema": { - "title": "groups", - "type": "array", - "items": { - "title": "group", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "WorkflowBuilder.apiread", - "WorkflowBuilder.authorization" - ], - "CookieAuth": [ - "WorkflowBuilder.apiread", - "WorkflowBuilder.authorization" - ], - "BasicAuth": [ - "WorkflowBuilder.apiread", - "WorkflowBuilder.authorization" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Overwrite Groups for a Workflow", - "description": "Overwrite the list of groups that have access to a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.replaceWorkflowGroups", - "responses": { - "200": { - "description": "Status of Overwrite", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkflowBuilder.authorization"], - "CookieAuth": ["WorkflowBuilder.authorization"], - "BasicAuth": ["WorkflowBuilder.authorization"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "title": "groups", - "type": "array", - "items": { - "title": "group", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Add Group to Workflow", - "description": "Add a group to the list of groups for a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.createWorkflowGroupEntry", - "responses": { - "200": { - "description": "Status of Overwrite", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkflowBuilder.authorization"], - "CookieAuth": ["WorkflowBuilder.authorization"], - "BasicAuth": ["WorkflowBuilder.authorization"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "title": "group", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete all Groups for a Workflow", - "description": "Remove all authorization restriction for a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.deleteWorkflowGroups", - "responses": { - "200": { - "description": "Status of Delete", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkflowBuilder.authorization"], - "CookieAuth": ["WorkflowBuilder.authorization"], - "BasicAuth": ["WorkflowBuilder.authorization"] - } - ], - "deprecated": false - } - }, - "/workflow_builder/workflows/{name}/groups/{group}": { - "delete": { - "summary": "Remove a Group from a Workflow", - "description": "Remove a group from the list of authorized groups for a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - }, - { - "name": "group", - "in": "path", - "description": "A Group Name", - "required": true, - "schema": { - "title": "group", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - ], - "operationId": "WorkflowBuilder.removeWorkflowGroup", - "responses": { - "200": { - "description": "Status of Removal", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkflowBuilder.authorization"], - "CookieAuth": ["WorkflowBuilder.authorization"], - "BasicAuth": ["WorkflowBuilder.authorization"] - } - ], - "deprecated": false - } - }, - "/workflow_builder/export": { - "post": { - "summary": "Export Workflow", - "description": "Export a single Workflow", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.exportWorkflow", - "responses": { - "200": { - "description": "Exported Workflow", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowPayload" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"], - "CookieAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"], - "BasicAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectId", - "description": "Id of Workflow document", - "examples": [ - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "name": { - "type": "string", - "description": "The name of the workflow. When provided, 'type' can also be specified for additional filtering.", - "examples": ["ciscoIOSsoftwareUpgrade"] - }, - "type": { - "type": "string", - "description": "The type of the workflow. It is an optional field and is used in conjunction with 'name' for filtering." - } - }, - "required": ["_id", "name"], - "oneOf": [ - { - "required": ["_id"] - }, - { - "required": ["name"] - } - ], - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/workflow_builder/import": { - "post": { - "summary": "Import Workflow", - "description": "Import a single Workflow", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.importWorkflow", - "responses": { - "200": { - "description": "Import status Object", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "result" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["WorkflowBuilder.admin"], - "CookieAuth": ["WorkflowBuilder.admin"], - "BasicAuth": ["WorkflowBuilder.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/workflow_builder_workflowPayload" - }, - "options": { - "type": "object", - "properties": { - "adapterMap": { - "type": "object" - } - } - } - } - } - } - } - } - } - }, - "/template_builder/templates/{name}/renderJinja": { - "post": { - "summary": "Render Jinja Template", - "description": "Renders jinja template output.", - "tags": ["template_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Template name", - "required": true, - "schema": { - "type": "string", - "examples": [ - "Template name 1", - "Template name 2", - "Template name 3" - ] - } - } - ], - "operationId": "TemplateBuilder.renderJinjaTemplate", - "responses": { - "200": { - "description": "Rendered jinja template", - "content": { - "application/json": { - "schema": { - "title": "renderedTemplate", - "type": "object", - "examples": [ - { - "renderedTemplate": "John was born in year 2000" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ], - "CookieAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ], - "BasicAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "object", - "examples": [ - { - "name": "John", - "DOB": "2000/1/1" - } - ] - } - } - } - } - } - } - } - }, - "/template_builder/parseTemplate": { - "post": { - "summary": "Parse templates based on the text and textfsm template sent in.", - "description": "Parse templates based on the text and textfsm template sent in.", - "tags": ["template_builder"], - "parameters": [], - "operationId": "TemplateBuilder.parseTemplate", - "responses": { - "200": { - "description": "Results from textfsm", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ], - "CookieAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ], - "BasicAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/template_builder_parseTemplateInput" - } - } - } - } - } - } - } - }, - "/template_builder/applyTemplate": { - "post": { - "summary": "Apply a template to text", - "description": "Apply a template to parse text", - "tags": ["template_builder"], - "parameters": [], - "operationId": "TemplateBuilder.applyTemplate", - "responses": { - "200": { - "description": "Parsed object based on the template and text provided", - "content": { - "application/json": { - "schema": { - "title": "parsed", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], - "CookieAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], - "BasicAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "text": { - "type": "string", - "examples": [ - "Template input text 1", - "Template input text 2", - "Template input text 3" - ] - }, - "template": { - "type": "string", - "examples": [ - "Template name 1", - "Template name 2", - "Template name 3" - ] - } - } - } - } - } - } - } - }, - "/template_builder/applyTemplates": { - "post": { - "summary": "Apply templates to text", - "description": "Apply templates to parse text", - "tags": ["template_builder"], - "parameters": [], - "operationId": "TemplateBuilder.applyTemplates", - "responses": { - "200": { - "description": "Parsed text based on the templates used", - "content": { - "application/json": { - "schema": { - "title": "parsed", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - [ - "Template output 1", - "Template output 2", - "Template output 3" - ] - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], - "CookieAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], - "BasicAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "text": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - [ - "Template input text 1", - "Template input text 2", - "Template input text 3" - ] - ] - }, - "templates": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - ["Template name 1", "Template name 2", "Template name 3"] - ] - } - } - } - } - } - } - } - }, - "/operations-manager/automations/clone": { - "post": { - "summary": "Clone Automation", - "description": "Clone an Automation.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.cloneAutomation", - "responses": { - "200": { - "description": "The result of the clone operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_automation-api" - }, - "metadata": { - "type": "object", - "properties": { - "automaticChanges": { - "type": "array", - "items": { - "title": "messages", - "type": "string", - "example": "Disabled trigger 628672e8f677b67b3b0f20d7" - } - }, - "triggerCloneResults": { - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Imported 3 of 3 document(s)."] - }, - "metadata": { - "type": "object" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "data": { - "$ref": "#/components/schemas/operations-manager_trigger-api" - }, - "automaticChanges": { - "type": "array", - "items": { - "title": "messages", - "type": "string", - "example": "Disabled trigger 628672e8f677b67b3b0f20d7" - } - } - } - } - } - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "automation", - "content": { - "application/json": { - "schema": { - "title": "automation", - "properties": { - "id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - "name": { - "description": "An optional name to use for the clone.", - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/operations-manager_common_name" - } - ] - } - } - } - } - } - } - } - }, - "/operations-manager/automations": { - "post": { - "summary": "Create Automation", - "description": "Create a new Automation.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.createAutomation", - "responses": { - "200": { - "description": "The result of the create operation.", - "content": { - "application/json": { - "schema": { - "title": "results", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - "gbac": { - "$ref": "#/components/schemas/operations-manager_automation-common_gbac" - }, - "componentId": { - "$ref": "#/components/schemas/operations-manager_automation-common_componentId" - } - } - } - ] - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "automation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_automation-create" - } - } - } - } - }, - "get": { - "summary": "Get Automations", - "description": "Search the Automation collection.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.getAutomations", - "responses": { - "200": { - "description": "The Automations that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_automation-api" - } - }, - "metadata": { - "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Import Automations", - "description": "Import Automations.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.importAutomations", - "responses": { - "200": { - "description": "The result of the import operation.", - "content": { - "application/json": { - "schema": { - "title": "status", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - "gbac": { - "$ref": "#/components/schemas/operations-manager_automation-common_gbac" - }, - "componentId": { - "$ref": "#/components/schemas/operations-manager_automation-common_componentId" - } - } - } - ] - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "automations": { - "title": "automations", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_automation-json" - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "adapterMap": { - "type": "object", - "description": "A mapping of provenance names to be converted upon import, specified in \"old_name\": \"new_name\" format.", - "examples": [ - { - "staging": "production" - }, - { - "old_name": "new_name" - } - ] - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/operations-manager/automations/{id}": { - "delete": { - "summary": "Delete Automation", - "description": "Delete an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Automation to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteAutomation", - "responses": { - "200": { - "description": "The result of the delete operation.", - "content": { - "application/json": { - "schema": { - "title": "results", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "null" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get Automation", - "description": "Get an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Automation to get.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.getAutomation", - "responses": { - "200": { - "description": "The requested Automation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_automation-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update Automation", - "description": "Update an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Automation to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.updateAutomation", - "responses": { - "200": { - "description": "The result of the update operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - "gbac": { - "$ref": "#/components/schemas/operations-manager_automation-common_gbac" - }, - "componentId": { - "$ref": "#/components/schemas/operations-manager_automation-common_componentId" - } - } - } - ] - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_automation-update" - } - } - } - } - } - }, - "/operations-manager/automations/{id}/export": { - "get": { - "summary": "Export Automation", - "description": "Export an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Automation to export.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.exportAutomation", - "responses": { - "200": { - "description": "The result of the export operation.", - "content": { - "application/json": { - "schema": { - "title": "document", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_automation-json" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers": { - "get": { - "summary": "Get Triggers", - "description": "Search the Trigger collection.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document", - "required": false, - "schema": { - "type": "string", - "examples": ["event"], - "description": "the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document" - } - }, - { - "name": "containsField", - "in": "query", - "description": "the field to run a contains query on", - "required": false, - "schema": { - "type": "string", - "examples": ["name"], - "description": "the field to run a contains query on" - } - }, - { - "name": "equals", - "in": "query", - "description": "the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document", - "required": false, - "schema": { - "type": "string", - "examples": ["my event trigger"], - "description": "the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document" - } - }, - { - "name": "equalsField", - "in": "query", - "description": "the field to run an equals query on", - "required": false, - "schema": { - "type": "string", - "examples": ["name"], - "description": "the field to run an equals query on" - } - }, - { - "name": "startsWith", - "in": "query", - "description": "the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document", - "required": false, - "schema": { - "type": "string", - "examples": ["my"], - "description": "the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document" - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "the field to run a startsWith query on", - "required": false, - "schema": { - "type": "string", - "examples": ["name"], - "description": "the field to run a startsWith query on" - } - }, - { - "name": "greaterThanField", - "in": "query", - "description": "the field to run a greater than query on", - "required": false, - "schema": { - "type": "string", - "examples": ["lastExecuted"], - "description": "the field to run a greater than query on" - } - }, - { - "name": "greaterThan", - "in": "query", - "description": "the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds", - "required": false, - "schema": { - "type": "string", - "examples": [ - "04/06/2021", - "Thu Dec 03 2020 14:55:00 GMT-0500 (Eastern Standard Time)", - "2020-12-03T19:55:43.189Z", - "1617681600000" - ], - "description": "the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds" - } - }, - { - "name": "lessThanField", - "in": "query", - "description": "the field to run a less than query on", - "required": false, - "schema": { - "type": "string", - "examples": ["lastExecuted"], - "description": "the field to run a less than query on" - } - }, - { - "name": "lessThan", - "in": "query", - "description": "the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds", - "required": false, - "schema": { - "type": "string", - "examples": [ - "04/06/2021", - "Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time)", - "2020-12-03T19:55:43.189Z", - "1615611600000" - ], - "description": "the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds" - } - }, - { - "name": "enabled", - "in": "query", - "description": "if true, then only return trigger documents that are enabled", - "required": false, - "schema": { - "type": "boolean", - "description": "if true, then only return trigger documents that are enabled" - } - }, - { - "name": "actionId", - "in": "query", - "description": "if provided, only return trigger documents with this action id", - "required": false, - "schema": { - "type": "string", - "description": "if provided, only return trigger documents with this action id" - } - }, - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by. Default is name.", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by. Default is name.", - "default": "name", - "enum": ["name"] - } - } - ], - "operationId": "OperationsManager.getTriggers", - "responses": { - "200": { - "description": "The Triggers that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_trigger-api" - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Create Trigger", - "description": "Create a new Trigger.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.createTrigger", - "responses": { - "200": { - "description": "The result of the create operation.", - "content": { - "application/json": { - "schema": { - "title": "createdTigger", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - ] - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "trigger", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_trigger-create" - } - } - } - } - }, - "put": { - "summary": "Import Triggers", - "description": "Import Triggers.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.importTriggers", - "responses": { - "200": { - "description": "The result of the import operation.", - "content": { - "application/json": { - "schema": { - "title": "createdTigger", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - ] - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "triggers": { - "title": "triggers", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_trigger-json" - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "adapterMap": { - "type": "object", - "description": "A mapping of provenance names to be converted upon import, specified in \"old_name\": \"new_name\" format.", - "examples": [ - { - "staging": "production" - }, - { - "old_name": "new_name" - } - ] - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/operations-manager/triggers/{id}": { - "get": { - "summary": "Get Trigger", - "description": "Get a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Trigger to get.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.getTrigger", - "responses": { - "200": { - "description": "The requested Trigger.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_trigger-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update Trigger", - "description": "Update a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Trigger to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.updateTrigger", - "responses": { - "200": { - "description": "The result of the update operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - ] - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_trigger-update" - } - } - } - } - }, - "delete": { - "summary": "Delete Trigger", - "description": "Delete a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Trigger to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteTrigger", - "responses": { - "200": { - "description": "The result of the delete operation.", - "content": { - "application/json": { - "schema": { - "title": "success", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "null" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers/action/{id}": { - "delete": { - "summary": "Delete Triggers By Action ID", - "description": "Deletes all Triggers associated with the provided Automation id.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the parent Automation.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteTriggersByActionId", - "responses": { - "200": { - "description": "The result of the delete operation.", - "content": { - "application/json": { - "schema": { - "title": "deletedCount", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "null" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers/{id}/export": { - "get": { - "summary": "Export Trigger", - "description": "Export a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Trigger to export.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.exportTrigger", - "responses": { - "200": { - "description": "The result of the export operation.", - "content": { - "application/json": { - "schema": { - "title": "document", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_trigger-json" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/large-data/{id}": { - "get": { - "summary": "Export large data for a job or task variable", - "description": "Export large data for a job or task variable", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the job_data document in GridFS", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.exportLargeData", - "responses": { - "200": { - "description": "The requested data", - "content": { - "application/json": { - "schema": { - "title": "result", - "oneOf": [ - { - "type": "object" - }, - { - "type": "array" - }, - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "description": "The decoded job data stored in GridFS" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/events": { - "get": { - "summary": "", - "description": "Search the system events that can be used in an event Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "source", - "in": "query", - "description": "source", - "required": false, - "schema": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" - } - }, - { - "name": "topic", - "in": "query", - "description": "topic", - "required": false, - "schema": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" - } - } - ], - "operationId": "OperationsManager.getEvents", - "responses": { - "200": { - "description": "The events that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" - }, - "topic": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/events/{source}/{topic}": { - "get": { - "summary": "", - "description": "Get an event definition.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "source", - "in": "path", - "description": "source", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" - } - }, - { - "name": "topic", - "in": "path", - "description": "topic", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" - } - } - ], - "operationId": "OperationsManager.getEventDefinition", - "responses": { - "200": { - "description": "The requested event definition.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" - }, - "topic": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" - }, - "definition": { - "type": "object", - "description": "The schema of the event.", - "$comment": "See draft 7 specification: http://json-schema.org/draft-07/schema#" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers/endpoint/{routeName}": { - "post": { - "summary": "Run Endpoint Trigger With POST", - "description": "Runs the Automation associated with the API Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "routeName", - "in": "path", - "description": "The routeName of the API Trigger.", - "required": true, - "schema": { - "title": "routeName", - "type": "string" - } - } - ], - "operationId": "OperationsManager.runEndpointTriggerWithPost", - "responses": { - "200": { - "description": "The spawned Job.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "body", - "content": { - "application/json": { - "schema": { - "title": "body", - "type": "object", - "properties": {}, - "additionalProperties": true - } - } - } - } - } - }, - "/operations-manager/triggers/manual/{id}/run": { - "post": { - "summary": "Run Manual Trigger", - "description": "Runs the Automation associated with the Manual Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Manual Trigger to run.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.runManualTrigger", - "responses": { - "200": { - "description": "The spawned Job.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "formData": { - "title": "formData", - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "runtimeOptions": { - "title": "runtimeOptions", - "default": {}, - "properties": { - "targetType": { - "enum": ["instance", "group"] - }, - "targetIdentifier": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/tasks/{taskId}/retry": { - "post": { - "summary": "Retry a task", - "description": "Retry a Task that has failed execution.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job containing the Task.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "taskId", - "in": "path", - "description": "The id of the Task to be retried.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_task-common_taskId" - } - } - ], - "operationId": "OperationsManager.retryTask", - "responses": { - "200": { - "description": "The result of the retry operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["OperationsManager.retryUser"], - "CookieAuth": ["OperationsManager.retryUser"], - "BasicAuth": ["OperationsManager.retryUser"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "variables": { - "title": "variables", - "type": "object", - "properties": {}, - "additionalProperties": true - } - } - } - } - } - } - } - }, - "/operations-manager/tasks/{taskId}/claim": { - "post": { - "summary": "Claim a task", - "description": "Assign a Task to the current user.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "taskId", - "in": "path", - "description": "The id of the Task iteration to be claimed.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_uuid-v4" - } - } - ], - "operationId": "OperationsManager.claimTask", - "responses": { - "200": { - "description": "The result of the claim operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/tasks/{taskId}/assign": { - "post": { - "summary": "Assign a task to a user", - "description": "Assign a Task to a user.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "taskId", - "in": "path", - "description": "The id of the Task iteration to be assigned.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_uuid-v4" - } - } - ], - "operationId": "OperationsManager.assignTask", - "responses": { - "200": { - "description": "The result of the assign operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "userId": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - }, - "/operations-manager/tasks/{taskId}/release": { - "post": { - "summary": "Release a currently assigned task", - "description": "Remove user assignment from a currently assigned Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "taskId", - "in": "path", - "description": "The id of the Task iteration to be released.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_uuid-v4" - } - } - ], - "operationId": "OperationsManager.releaseTask", - "responses": { - "200": { - "description": "The result of the release operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/tasks": { - "get": { - "summary": "Gets Tasks", - "description": "Search the Task collection.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "in", - "in": "query", - "description": "Search for fields exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "not-in", - "in": "query", - "description": "Search for fields not exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "equals", - "in": "query", - "description": "Returns results where the specified fields exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string" - } - }, - { - "name": "contains", - "in": "query", - "description": "Returns results where the specified fields contain the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields contain the given match string(s).", - "type": "string" - } - }, - { - "name": "starts-with", - "in": "query", - "description": "Returns results where the specified fields start with the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string" - } - }, - { - "name": "ends-with", - "in": "query", - "description": "Returns results where the specified fields end in the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string" - } - }, - { - "name": "dereference", - "in": "query", - "description": "Designates foreign key fields to dereference in the API output.", - "required": false, - "schema": { - "description": "Designates foreign key fields to dereference in the API output.", - "type": "string" - } - }, - { - "name": "gt", - "in": "query", - "description": "Returns results where the specified fields have values greater than the specified values.", - "required": false, - "schema": { - "description": "Returns results where the specified fields have values greater than the specified values.", - "type": "string" - } - }, - { - "name": "gte", - "in": "query", - "description": "Returns results where the specified fields have values greater than or equal to the specified values.", - "required": false, - "schema": { - "description": "Returns results where the specified fields have values greater than or equal to the specified values.", - "type": "string" - } - }, - { - "name": "lt", - "in": "query", - "description": "Returns results where the specified fields have values less than the specified values.", - "required": false, - "schema": { - "description": "Returns results where the specified fields have values less than the specified values.", - "type": "string" - } - }, - { - "name": "lte", - "in": "query", - "description": "Returns results where the specified fields have values less than or equal to the specified values.", - "required": false, - "schema": { - "description": "Returns results where the specified fields have values less than or equal to the specified values.", - "type": "string" - } - }, - { - "name": "q", - "in": "query", - "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", - "required": false, - "schema": { - "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", - "type": "string" - } - }, - { - "name": "actionableTasks", - "in": "query", - "description": "If true, only returns actionable tasks that the current user has write access to.", - "required": false, - "schema": { - "type": "boolean", - "description": "If true, only returns actionable tasks that the current user has write access to.", - "default": false - } - } - ], - "operationId": "OperationsManager.getTasks", - "responses": { - "200": { - "description": "The Tasks that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - }, - "metadata": { - "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/tasks/{id}": { - "get": { - "summary": "Get a task by ID", - "description": "Get a Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Task to get.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "dereference", - "in": "query", - "description": "Designates foreign key fields to dereference in the API output. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.", - "required": false, - "schema": { - "type": "string", - "description": "Designates foreign key fields to dereference in the API output. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.", - "examples": ["job", "accounts.metrics.owner"] - } - } - ], - "operationId": "OperationsManager.getTask", - "responses": { - "200": { - "description": "The requested Task.", - "content": { - "application/json": { - "schema": { - "title": "task", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/{jobId}/watch": { - "post": { - "summary": "Watch a Job", - "description": "Adds the current user to the list of watchers on a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to watch.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.watchJob", - "responses": { - "200": { - "description": "The result of the watch operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/unwatch": { - "post": { - "summary": "Unwatch Jobs", - "description": "Removes the current user from the list of watchers on multiple Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.unwatchJobs", - "responses": { - "200": { - "description": "The result of the unwatch operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/watch": { - "post": { - "summary": "Watch Jobs", - "description": "Adds the current user to the list of watchers on multiple Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.watchJobs", - "responses": { - "200": { - "description": "The result of the watch operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/unwatch": { - "post": { - "summary": "Unwatch Job", - "description": "Removes the current user from the list of watchers on a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to unwatch.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.unwatchJob", - "responses": { - "200": { - "description": "The result of the unwatch operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/{jobId}/add-watchers": { - "post": { - "summary": "Add watchers to a Job", - "description": "Adds user ids to the list of watchers on a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to assign watchers to.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.addWatchersToJob", - "responses": { - "200": { - "description": "The result of the add watchers operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "userIds": { - "title": "userIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/tasks/{taskId}/finish": { - "post": { - "summary": "Finish a manual task", - "description": "Work a manual Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job containing the Task to be worked.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "taskId", - "in": "path", - "description": "The id of the Task to be worked.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_job-common_taskId" - } - } - ], - "operationId": "OperationsManager.finishManualTask", - "responses": { - "200": { - "description": "The result of the finish manual Task operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskData": { - "title": "taskData", - "type": "object", - "properties": { - "finish_state": { - "type": "string" - }, - "variables": { - "type": "object" - } - }, - "required": ["finish_state", "variables"] - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/tasks/{taskId}/manual-controller": { - "get": { - "summary": "Get a client-side dialog controller for a manual task", - "description": "Get a client-side dialog controller for a manual task", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job containing the task", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "taskId", - "in": "path", - "description": "The id of the Task containing the dialog controller.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_task-common_taskId" - } - } - ], - "operationId": "OperationsManager.getManualTaskController", - "responses": { - "200": { - "description": "The requested dialog controller.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string" - }, - "decorators": { - "$ref": "#/components/schemas/operations-manager_common_decorators" - } - } - }, - "finish_state": { - "type": "string" - }, - "TaskController": { - "type": "string", - "description": "A Javascript function named TaskController." - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/{id}": { - "get": { - "summary": "Get a Job", - "description": "Get a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Job to get.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "dereference", - "in": "query", - "description": "Designates foreign key fields to dereference in the API output.", - "required": false, - "schema": { - "type": "string", - "description": "Designates foreign key fields to dereference in the API output.", - "examples": ["tasks", "accounts.createdBy"] - } - } - ], - "operationId": "OperationsManager.getJob", - "responses": { - "200": { - "description": "The requested Job.", - "content": { - "application/json": { - "schema": { - "title": "job", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs": { - "get": { - "summary": "Gets Jobs", - "description": "Search the Job collection.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.getJobs", - "responses": { - "200": { - "description": "The Jobs that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - }, - "metadata": { - "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/start": { - "post": { - "summary": "Start a Job", - "description": "Spawns a Job from a Workflow.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.startJob", - "responses": { - "200": { - "description": "The spawned Job.", - "content": { - "application/json": { - "schema": { - "title": "job", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "title": "workflow", - "type": "string" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description for the new Job.", - "examples": ["Example job description"] - }, - "type": { - "type": "string", - "examples": ["automation"] - }, - "variables": { - "type": "object", - "description": "Variables for the new Job.", - "additionalProperties": true - }, - "groups": { - "type": "array", - "description": "GBAC for the new Job.", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/pause": { - "post": { - "summary": "Pauses Jobs", - "description": "Pause active Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.pauseJobs", - "responses": { - "200": { - "description": "The result of the pause operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/resume": { - "post": { - "summary": "Resumes Jobs", - "description": "Resumes paused Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.resumeJobs", - "responses": { - "200": { - "description": "The result of the resume operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/cancel": { - "post": { - "summary": "Cancels Jobs", - "description": "Cancel Active Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.cancelJobs", - "responses": { - "200": { - "description": "The result of the cancel operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "type": "array", - "title": "jobIds", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/groups": { - "post": { - "summary": "Add GBAC to a Job", - "description": "Add a group id to the groups array of a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to modify.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.addJobGroup", - "responses": { - "200": { - "description": "The result of the add group operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "const": true - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupId": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - }, - "delete": { - "summary": "Remove all GBAC from a Job", - "description": "Remove all groups from the groups array of a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to modify.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteJobGroups", - "responses": { - "200": { - "description": "The result of the delete groups operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "const": true - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Replace all GBAC from a Job with the provided list", - "description": "Replace all groups from the groups array of a Job with the provided group array.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to modify.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.replaceJobGroups", - "responses": { - "200": { - "description": "The result of the replace groups operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "const": true - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "title": "groups", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/groups/{groupId}": { - "delete": { - "summary": "Remove GBAC from a Job", - "description": "Remove a group id from the groups array of a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to modify.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "groupId", - "in": "path", - "description": "The group id to add to the Job.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteJobGroup", - "responses": { - "200": { - "description": "The result of the delete group operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "const": true - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/{jobId}": { - "delete": { - "summary": "Delete a root job and all related items", - "description": "Only succeeds on completed or cancelled root jobs. Recursively deletes children, tasks, job data, job history, and large files.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteJob", - "responses": { - "200": { - "description": "The result of the delete job operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "type": "array", - "items": { - "type": "object" - } - }, - "metadata": { - "type": "object" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/delete": { - "post": { - "summary": "Deletes a list of provided root jobs and all their related items", - "description": "Only succeeds on completed or cancelled root jobs. Ignores jobs that don't fit that criteria. Recursively deletes children, tasks, job data, job history, and large files.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.deleteJobs", - "responses": { - "200": { - "description": "The result of the delete jobs operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "type": "array", - "items": { - "type": "object" - } - }, - "metadata": { - "type": "object" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/continue": { - "post": { - "summary": "Continue a Job from a specified Task", - "description": "Continue a Job from a specified Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to be continued.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.continueJobFrom", - "responses": { - "200": { - "description": "The result of the continue operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["OperationsManager.retryUser"], - "CookieAuth": ["OperationsManager.retryUser"], - "BasicAuth": ["OperationsManager.retryUser"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "fromTask": { - "$ref": "#/components/schemas/operations-manager_task-common_taskId" - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/revert": { - "post": { - "summary": "Revert a Job", - "description": "Revert a paused Job from an errored Task to a previously completed Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to be reverted.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.revertJob", - "responses": { - "200": { - "description": "The result of the revert operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "fromTask": { - "$ref": "#/components/schemas/operations-manager_task-common_taskId" - }, - "toTask": { - "$ref": "#/components/schemas/operations-manager_job-common_taskId" - } - } - } - } - } - } - } - }, - "/operations-manager/automations/{automationIdentifier}/validate": { - "post": { - "summary": "Validate Automation", - "description": "Run configuration validations against an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "automationIdentifier", - "in": "path", - "description": "automationIdentifier", - "required": true, - "schema": { - "title": "automationIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/operations-manager_common_name" - } - ] - } - } - ], - "operationId": "OperationsManager.validateAutomation", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - } - }, - "warnings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers/{triggerId}/validate": { - "post": { - "summary": "Validate Trigger", - "description": "Run configuration validations against a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "triggerId", - "in": "path", - "description": "triggerId", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.validateTrigger", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - } - }, - "warnings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false - } - }, - "/mop/export": { - "post": { - "summary": "Export Template", - "description": "Export a single template", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.exportTemplate", - "responses": { - "200": { - "description": "Exported Template", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - }, - { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiread"], - "CookieAuth": ["MOP.admin", "MOP.apiread"], - "BasicAuth": ["MOP.admin", "MOP.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "examples": [ - { - "_id": "mop_test_123" - }, - { - "name": "mop_test_123" - } - ] - }, - "type": { - "title": "type", - "type": "string", - "enum": ["templates", "analytics"] - } - } - } - } - } - } - } - }, - "/mop/import": { - "post": { - "summary": "Import Template", - "description": "Import a single template", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.importTemplate", - "responses": { - "200": { - "description": "Import status", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "anyOf": [ - { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - }, - { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - ] - }, - "type": { - "type": "string", - "title": "type", - "enum": ["templates", "analytics"] - } - } - } - } - } - } - } - }, - "/mop/listTemplates": { - "get": { - "summary": "Get All Command Templates", - "description": "Get all Command Templates.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.listTemplates", - "responses": { - "200": { - "description": "All Command Templates.", - "content": { - "application/json": { - "schema": { - "title": "listTemplates", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false - } - }, - "/mop/listATemplate/{name}": { - "get": { - "summary": "Get a Command Template by Name", - "description": "Get a Command Template by name.", - "tags": ["mop"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the Command Template.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_name" - } - } - ], - "operationId": "MOP.listATemplate", - "responses": { - "200": { - "description": "Single Command Template matching the name.", - "content": { - "application/json": { - "schema": { - "title": "listATemplate", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false - } - }, - "/mop/listAnAnalyticTemplate/{name}": { - "get": { - "summary": "Get an Analytic Template by Name", - "description": "Get an Analytic Template by name.", - "tags": ["mop"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the Analytic Template.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc_name" - } - } - ], - "operationId": "MOP.listAnAnalyticTemplate", - "responses": { - "200": { - "description": "Single Analytic Template wrapped in an array.", - "content": { - "application/json": { - "schema": { - "title": "listAnAnalyticTemplate", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false - } - }, - "/mop/listAnalyticTemplates": { - "get": { - "summary": "Get All Analytic Templates", - "description": "Get all Analytic Templates.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.listAnalyticTemplates", - "responses": { - "200": { - "description": "All Analytic Templates.", - "content": { - "application/json": { - "schema": { - "title": "listAnalyticTemplates", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false - } - }, - "/mop/createTemplate": { - "post": { - "summary": "Create a Command Template", - "description": "Create a Command Template.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.createTemplate", - "responses": { - "200": { - "description": "Result of the creation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mop": { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - } - } - } - } - } - } - } - }, - "/mop/createAnalyticTemplate": { - "post": { - "summary": "Create an Analytic Template", - "description": "Create an Analytic Template.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.createAnalyticTemplate", - "responses": { - "200": { - "description": "Result of the creation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - } - } - } - } - }, - "/mop/deleteTemplate/{id}": { - "post": { - "summary": "Delete a Command Template", - "description": "Delete a Command Template by ID.", - "tags": ["mop"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of the template to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc__id" - } - } - ], - "operationId": "MOP.deleteTemplate", - "responses": { - "200": { - "description": "Status of the deletion.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false - } - }, - "/mop/deleteAnalyticTemplate/{id}": { - "post": { - "summary": "Delete an Analytic Template", - "description": "Delete an Analytic Template by ID.", - "tags": ["mop"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of the Analytic Template to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc__id" - } - } - ], - "operationId": "MOP.deleteAnalyticTemplate", - "responses": { - "200": { - "description": "Status of the deletion.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false - } - }, - "/mop/updateTemplate/{mopID}": { - "post": { - "summary": "Update a Command Template", - "description": "Update a Command Template by ID.", - "tags": ["mop"], - "parameters": [ - { - "name": "mopID", - "in": "path", - "description": "ID of the Command Template to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_name" - } - }, - { - "name": "mop", - "in": "path", - "description": "Command Template to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - } - } - ], - "operationId": "MOP.updateTemplate", - "responses": { - "200": { - "description": "Status of the update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false - } - }, - "/mop/updateAnalyticTemplate/{mopID}": { - "post": { - "summary": "Update an Analytic Template", - "description": "Update an Analytic Template by ID.", - "tags": ["mop"], - "parameters": [ - { - "name": "mopID", - "in": "path", - "description": "ID of the Analytic Template to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc__id" - } - } - ], - "operationId": "MOP.updateAnalyticTemplate", - "responses": { - "200": { - "description": "Status of the update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - } - } - } - } - }, - "/mop/RunCommandDevices": { - "post": { - "summary": "Run a Command against Devices", - "description": "Run a command against devices.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.RunCommandDevices", - "responses": { - "200": { - "description": "Result of the command run.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "command": { - "title": "command", - "type": "string", - "examples": ["show version"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - }, - "devices": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - } - } - } - } - } - } - } - }, - "/mop/RunCommand": { - "post": { - "summary": "Run a Command against a Device", - "description": "Run a command against a device.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.RunCommand", - "responses": { - "200": { - "description": "Result of the command run.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "command": { - "title": "command", - "type": "string", - "examples": ["show version"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - }, - "device": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_device" - } - } - } - } - } - } - } - }, - "/mop/RunCommandTemplate": { - "post": { - "summary": "Run Command Template", - "description": "Run a Command Template against devices.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.RunCommandTemplate", - "responses": { - "200": { - "description": "Result of the Command Template run.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "title": "template", - "type": "string", - "examples": ["show version"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - }, - "devices": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - } - } - } - } - } - } - } - }, - "/mop/RunCommandTemplateSingleCommand": { - "post": { - "summary": "Run single command from template", - "description": "Run a single command from a template on a devices.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.RunCommandTemplateSingleCommand", - "responses": { - "200": { - "description": "Result of the Command Template run.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "templateId": { - "$ref": "#/components/schemas/mop_mopTemplateDoc__id" - }, - "commandIndex": { - "title": "commandIndex", - "type": "integer", - "examples": [0] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - }, - "devices": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - } - } - } - } - } - } - } - }, - "/mop/GetBootFlash": { - "post": { - "summary": "MOP Get Boot Flash", - "description": "Get the boot flash image", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.GetBootFlash", - "responses": { - "200": { - "description": "Binary file name currently being used by router", - "content": { - "application/json": { - "schema": { - "title": "imageName", - "type": "string", - "examples": ["10011011"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "device": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_device" - } - } - } - } - } - } - } - }, - "/mop/passThru/{device}": { - "post": { - "summary": "MOP Pass Thru", - "description": "Pass Through to execute direct device commands", - "tags": ["mop"], - "parameters": [ - { - "name": "device", - "in": "path", - "description": "device", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_device" - } - } - ], - "operationId": "MOP.passThru", - "responses": { - "200": { - "description": "config", - "content": { - "application/json": { - "schema": { - "title": "config", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "command": { - "title": "command", - "type": "string", - "examples": ["show version"] - } - } - } - } - } - } - } - }, - "/mop/deviceObjects": { - "post": { - "summary": "Get Filtered Devices", - "description": "Get the devices with name matching the given options.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.getDeviceObjectsFiltered", - "responses": { - "200": { - "description": "Filtered devices", - "content": { - "application/json": { - "schema": { - "title": "devices", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_detailedDevice" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_options" - } - } - } - } - } - } - } - }, - "/mop/devices/detailed/{substring}": { - "get": { - "summary": "Get Filtered Devices with detailed query results", - "description": "Get the devices with name matching the given string. Also returns the number of results found and number returned", - "tags": ["mop"], - "parameters": [ - { - "name": "substring", - "in": "path", - "description": "String to filter devices", - "required": true, - "schema": { - "title": "substring", - "type": "string", - "examples": ["tes"] - } - } - ], - "operationId": "MOP.getDevicesFilteredDetailedResults", - "responses": { - "200": { - "description": "Filtered devices", - "content": { - "application/json": { - "schema": { - "title": "devices", - "type": "object", - "properties": { - "num_results": { - "type": "integer" - }, - "results": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - }, - "total_results": { - "type": "integer" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] - } - ], - "deprecated": false - } - }, - "/mop/diff": { - "post": { - "summary": "Find the diff of two config strings.", - "description": "Find the diff of two config strings.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.getDiff", - "responses": { - "200": { - "description": "Result of the diff.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "array", - "items": { - "type": "object", - "properties": { - "count": { - "type": "number" - }, - "value": { - "type": "string" - }, - "added": { - "type": "boolean" - }, - "removed": { - "type": "boolean" - } - } - }, - "examples": [ - [ - [ - { - "count": 1, - "value": "example string\n" - }, - { - "count": 2, - "removed": true, - "value": "example string\nextra added line" - } - ] - ] - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "value_a": { - "title": "value_a", - "type": "string", - "examples": ["any string"] - }, - "value_b": { - "title": "value_b", - "type": "string", - "examples": ["other string"] - } - } - } - } - } - } - } - }, - "/mop/runTemplatesDiffArray": { - "post": { - "summary": "MOP Diff Array", - "description": "Generates a diff for the input. By default, the API call timeout is 5 minutes for the platform. If this API call needs additional time, it can be modified in the Express timeout property. The supported timeout range would be a minimum of 8 minutes for a 2MB payload and a maximum of 32 minutes for a 4MB payload.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.runTemplatesDiffArray", - "responses": { - "200": { - "description": "diff", - "content": { - "application/json": { - "schema": { - "title": "diff", - "type": "object", - "properties": { - "onlyPre": { - "type": "object", - "properties": {} - }, - "diff": { - "type": "object", - "properties": {} - }, - "onlyPost": { - "type": "object", - "properties": {} - }, - "analytics": { - "type": "object", - "properties": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pre": { - "title": "pre", - "type": "array", - "items": { - "type": "string", - "examples": ["show version"] - } - }, - "post": { - "title": "post", - "type": "array", - "items": { - "type": "string", - "examples": ["show version"] - } - } - } - } - } - } - } - } - }, - "/mop/runAnalyticsTemplate": { - "post": { - "summary": "Run an Analytics Template", - "description": "Run an Analytic Template.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.runAnalyticsTemplate", - "responses": { - "200": { - "description": "Result of running Analytic Template", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pre": { - "title": "pre", - "type": "object", - "properties": { - "command": { - "type": "string" - }, - "commands_results": { - "type": "string" - } - }, - "examples": [ - { - "command": "show version", - "commands_results": "Cisco IOS Software, Version 1.2.3" - } - ] - }, - "post": { - "title": "post", - "type": "object", - "properties": { - "command": { - "type": "string" - }, - "commands_results": { - "type": "string" - } - }, - "examples": [ - { - "command": "show version", - "commands_results": "Cisco IOS Software, Version 1.2.3" - } - ] - }, - "analytic_template_name": { - "title": "analytic_template_name", - "type": "string", - "examples": ["test"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - } - } - } - } - } - } - } - }, - "/mop/runAnalyticsTemplateDevices": { - "post": { - "summary": "Run an Analytics Template for Devices", - "description": "Run an Analytic Template for Devices.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.runAnalyticsTemplateDevices", - "responses": { - "200": { - "description": "Result of running Analytic Template Devices", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pre": { - "title": "pre", - "type": "object", - "properties": { - "pre": { - "type": "object", - "properties": { - "commands_results": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["commands_results"], - "additionalProperties": false - } - } - }, - "post": { - "title": "post", - "type": "object", - "properties": { - "post": { - "type": "object", - "properties": { - "commands_results": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["commands_results"], - "additionalProperties": false - } - } - }, - "analytic_template_name": { - "title": "analytic_template_name", - "type": "string", - "examples": ["test"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - } - } - } - } - } - } - } - }, - "/mop/reattempt": { - "post": { - "summary": "Retry a task automatically for x number of attempts with n minute intervals.", - "description": "Workflow will follow reattempt task's outgoing transition after n minutes of delay.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.reattempt", - "responses": { - "200": { - "description": "Response from attempt", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "string", - "examples": ["Success"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "job_id": { - "title": "job_id", - "type": "string", - "examples": ["test"] - }, - "attemptID": { - "title": "attemptID", - "type": "string", - "examples": ["test1234"] - }, - "minutes": { - "title": "minutes", - "type": "integer", - "examples": [1] - }, - "attempts": { - "title": "attempts", - "type": "integer", - "examples": [2] - } - } - } - } - } - } - } - }, - "/mop/devices/{substring}": { - "get": { - "summary": "Get Filtered Devices", - "description": "Get the devices with name matching the given string.", - "tags": ["mop"], - "parameters": [ - { - "name": "substring", - "in": "path", - "description": "String to filter devices", - "required": true, - "schema": { - "title": "substring", - "type": "string", - "examples": ["tes"] - } - } - ], - "operationId": "MOP.getDevicesFiltered", - "responses": { - "200": { - "description": "Filtered devices", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/action-executions/{executionId}/cancel": { - "post": { - "summary": "Cancels an action execution", - "description": "Cancels an action execution, if targeting a bulk action execution, all its child executions will also be canceled.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "executionId", - "in": "path", - "description": "executionId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.cancelActionExecution", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/groups": { - "post": { - "summary": "Creates a new instance group", - "description": "Creates a new instance group", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.createInstanceGroupHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "instanceGroup", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-create" - } - } - } - } - }, - "get": { - "summary": "Gets multiple instance groups", - "description": "Gets multiple instance groups", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.getInstanceGroupsHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" - } - }, - "metadata": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources": { - "post": { - "summary": "Creates a new resource model", - "description": "Creates a new resource model", - "tags": ["lifecycle-manager"], - "parameters": [], - "operationId": "LifecycleManager.createResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "resourceModelData", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-create-data" - } - } - } - } - }, - "get": { - "summary": "Searches resource models", - "description": "Searches resource models", - "tags": ["lifecycle-manager"], - "parameters": [], - "operationId": "LifecycleManager.getResourceModelsHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" - } - }, - "metadata": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/groups/{groupIdentifier}": { - "delete": { - "summary": "Deletes an instance group", - "description": "Deletes an instance group", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - }, - { - "name": "groupIdentifier", - "in": "path", - "description": "groupIdentifier", - "required": true, - "schema": { - "title": "groupIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.deleteInstanceGroupHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - }, - "get": { - "summary": "Gets a single instance group", - "description": "Gets a single new instance group", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - }, - { - "name": "groupIdentifier", - "in": "path", - "description": "groupIdentifier", - "required": true, - "schema": { - "title": "groupIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.getInstanceGroupHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Updates a instance group", - "description": "Updates a instance group", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - }, - { - "name": "groupIdentifier", - "in": "path", - "description": "groupIdentifier", - "required": true, - "schema": { - "title": "groupIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.updateInstanceGroupHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-update" - } - } - } - } - } - }, - "/lifecycle-manager/resources/{id}": { - "delete": { - "summary": "Deletes a resource model", - "description": "A resource model will not be deleted if it has associated instances. To override this behavior and delete the resource model along with any associated instances, set the 'delete-associated-instances' flag to 'true'.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" - } - } - ], - "operationId": "LifecycleManager.deleteResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "queryParameters": { - "title": "queryParameters", - "type": "object", - "properties": { - "delete-associated-instances": { - "description": "If set to 'true', the resource model and any of its associated instances will be deleted.", - "type": "string" - } - }, - "required": [] - } - } - } - } - } - } - }, - "get": { - "summary": "Gets a resource model based on id", - "description": "Gets a resource model based on id", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ObjectId of the resource model", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" - } - }, - { - "name": "dereference", - "in": "query", - "description": "dereference", - "required": false, - "schema": { - "type": "string" - } - } - ], - "operationId": "LifecycleManager.getResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates a resource model", - "description": "Updates a resource model", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" - } - } - ], - "operationId": "LifecycleManager.updateResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "title": "updates", - "type": "object", - "properties": {} - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelId}/edit": { - "post": { - "summary": "Performs edits to a resource model", - "description": "Performs edits to a resource model. This method exists to support specific resource edit activities required by the UI.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "Resource model ID", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.editResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "properties", - "content": { - "application/json": { - "schema": { - "title": "properties", - "oneOf": [ - { - "type": "object", - "required": ["command", "action"], - "properties": { - "command": { - "type": "string", - "description": "Edit command to execute", - "enum": [ - "generate-action-workflow", - "generate-action-pre-transformation", - "generate-action-post-transformation" - ] - }, - "action": { - "description": "Resource action ID or pending action definition", - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action" - } - ] - }, - "overwrite": { - "description": "Tells the component generator to either disregard and overwrite an existing component on the action (when true) or to refuse to generate a new component (when false).", - "type": "boolean" - }, - "updateAction": { - "description": "Tells the component generator to either update the action in the database (when true) or to only generate and return the new component (when false)", - "type": "boolean" - } - } - } - ] - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/instances/{instanceIdentifier}/export": { - "get": { - "summary": "Exports a resource instance", - "description": "This method exports a resource instance.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - }, - { - "name": "instanceIdentifier", - "in": "path", - "description": "instanceIdentifier", - "required": true, - "schema": { - "title": "instanceIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.exportResourceInstanceHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-export" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelId}/export": { - "get": { - "summary": "Exports a resource model", - "description": "This method exports a resource model.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "modelId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.exportResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": true, - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-export" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/action-executions/{id}": { - "get": { - "summary": "Gets a single action execution record", - "description": "Gets a single action execution record", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.getActionExecution", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": true, - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/action-executions": { - "get": { - "summary": "Searches resource action history documents", - "description": "Searches resource action history documents", - "tags": ["lifecycle-manager"], - "parameters": [], - "operationId": "LifecycleManager.getActionExecutions", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": true, - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" - } - }, - "metadata": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelId}/instances/{instanceId}": { - "get": { - "summary": "Gets a single resource instance", - "description": "Gets a single resource instance", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "modelId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - }, - { - "name": "instanceId", - "in": "path", - "description": "The identifier of the resource instance", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.getResourceInstanceHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates the `name` and `description` fields of a resource instance", - "description": "Updates the `name` and `description` fields of a resource instance", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "modelId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - }, - { - "name": "instanceId", - "in": "path", - "description": "instanceId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.updateInstanceMetadataHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "title": "updates", - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_name" - }, - "description": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_description" - } - } - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelId}/instances": { - "get": { - "summary": "Searches resource instances", - "description": "Searches resource instances", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "modelId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.getResourceInstancesHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - }, - "metadata": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/instances/import": { - "post": { - "summary": "Imports an instance into a resource", - "description": "Imports an instance into a resource", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.importResourceInstanceHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "instance", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-export" - } - } - } - } - } - }, - "/lifecycle-manager/resources/import": { - "post": { - "summary": "Imports a resource model", - "description": "Imports a resource model", - "tags": ["lifecycle-manager"], - "parameters": [], - "operationId": "LifecycleManager.importResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": true, - "properties": { - "data": { - "type": "object", - "additionalProperties": false, - "properties": { - "_id": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - }, - "name": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_name" - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "importParameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-import" - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelId}/run-action": { - "post": { - "summary": "Runs a resource action", - "description": "Runs a resource action", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "The ID of the Resource Model to run an action on", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.runActionHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "required": ["actionId"], - "additionalProperties": false, - "properties": { - "actionId": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" - }, - "instance": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - ] - }, - "instanceName": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_name" - }, - "instanceDescription": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_description" - }, - "inputs": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/run-bulk-action": { - "post": { - "summary": "Runs a resource action against multiple instances", - "description": "Runs a resource action against multiple instances", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "The ID of the Resource Model to run an action on.", - "required": true, - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_name" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - ] - } - } - ], - "operationId": "LifecycleManager.runBulkActionHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "required": ["actionId"], - "additionalProperties": false, - "properties": { - "actionId": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" - }, - "group": { - "title": "groupIdentifier", - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - }, - "instances": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - }, - "inputs": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "inputOverrides": { - "oneOf": [ - { - "type": "array" - }, - { - "type": "null" - } - ] - } - } - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelId}/actions/validate": { - "post": { - "summary": "Validates the actions defined on a resource model", - "description": "This method validates the actions on a resource model. Each validation report has an associate severity, and designates whether or not it will prevent the action from saving, prevent the model from running, or both. It accepts pending edits to actions in the optional 'actions' body parameter in order to check for validation issues on unsaved, pending changes to an action", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "Resource model ID", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.validateActionsHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "OAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "properties", - "content": { - "application/json": { - "schema": { - "title": "properties", - "type": "object", - "required": [], - "properties": { - "actions": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_actions" - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "iap_accounts-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Account Schema", - "description": "This is the schema for an IAP account stored in Mongo", - "properties": { - "provenance": { - "title": "Provenance", - "description": "AAA provider where account originated", - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "title": "Username", - "description": "Username for account", - "type": "string", - "examples": ["john_doe"] - }, - "firstname": { - "title": "First Name", - "description": "The user's first name", - "type": "string", - "examples": ["John"] - }, - "memberOf": { - "title": "Assigned Groups", - "description": "Groups which this account is a part of", - "type": "array", - "items": { - "type": "object", - "properties": { - "aaaManaged": { - "description": "Whether group comes from an external AAA or not", - "type": "boolean" - }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "assignedRoles": { - "title": "Assigned Roles", - "description": "Roles assigned to this account", - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - }, - "additionalProperties": false - } - }, - "inactive": { - "title": "Inactive", - "description": "Setting for whether account is active or not", - "type": "boolean" - }, - "lastLogin": { - "title": "Last Login", - "description": "Date and time when the user last logged in", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "sso": { - "title": "sso", - "description": "Whether this is an SSO user", - "type": "boolean" - }, - "nameID": { - "title": "nameID", - "description": "Identifier for SSO account.", - "type": "string" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "title": "Created", - "description": "When the account was created", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updated": { - "title": "Updated", - "description": "When the account was last updated", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - } - } - }, - "email": { - "title": "Email", - "description": "Email for user", - "type": "string", - "examples": ["name@email.com"] - }, - "isServiceAccount": { - "description": "Value denoting if an account does not reflect a human user", - "type": "boolean" - }, - "loggedIn": { - "description": "Property used in the getAccounts API to indicate a user is currently logged in", - "type": "boolean" - }, - "gitTokens": { - "description": "Tokens used when interacting with Git APIs and features", - "type": "object", - "properties": { - "GitHub": { - "description": "Personal access token for GitHub", - "type": "string" - }, - "GitLab": { - "description": "Personal access token for GitLab", - "type": "string" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false, - "required": [ - "provenance", - "username", - "firstname", - "memberOf", - "assignedRoles", - "inactive", - "gitTokens" - ] - }, - "iap_accounts-schema_username": { - "title": "Username", - "description": "Username for account", - "type": "string", - "examples": ["john_doe"] - }, - "iap_accounts-schema_inactive": { - "title": "Inactive", - "description": "Setting for whether account is active or not", - "type": "boolean" - }, - "iap_accounts-schema_memberOf": { - "title": "Assigned Groups", - "description": "Groups which this account is a part of", - "type": "array", - "items": { - "type": "object", - "properties": { - "aaaManaged": { - "description": "Whether group comes from an external AAA or not", - "type": "boolean" - }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "iap_accounts-schema_assignedRoles": { - "title": "Assigned Roles", - "description": "Roles assigned to this account", - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - }, - "additionalProperties": false - } - }, - "iap_accounts-schema_email": { - "title": "Email", - "description": "Email for user", - "type": "string", - "examples": ["name@email.com"] - }, - "iap_accounts-schema_isServiceAccount": { - "description": "Value denoting if an account does not reflect a human user", - "type": "boolean" - }, - "iap_accounts-schema_loggedIn": { - "description": "Property used in the getAccounts API to indicate a user is currently logged in", - "type": "boolean" - }, - "iap_accounts-schema_gitTokens": { - "description": "Tokens used when interacting with Git APIs and features", - "type": "object", - "properties": { - "GitHub": { - "description": "Personal access token for GitHub", - "type": "string" - }, - "GitLab": { - "description": "Personal access token for GitLab", - "type": "string" - } - }, - "additionalProperties": false - }, - "iap_common-schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Common schema definitions" - }, - "iap_common-schema_status": { - "type": "string", - "description": "The status of the API request.", - "enum": ["OK", "Created"] - }, - "iap_common-schema_message": { - "type": "string", - "description": "Message containing either confirmation of the operation or the reason for the failure of the operation.", - "examples": ["A sample success message"] - }, - "iap_common-schema_limit": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - }, - "iap_common-schema_skip": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - }, - "iap_common-schema_order": { - "type": "integer", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "default": 1, - "enum": [-1, 1] - }, - "iap_common-schema_sort": { - "type": "string", - "description": "Field to sort by. Default is name.", - "default": "name", - "enum": ["name"] - }, - "iap_common-schema_isActive": { - "type": "boolean", - "description": "Is profile the active profile.", - "examples": [true, false] - }, - "iap_common-schema_activeSync": { - "type": "boolean", - "description": "Is active profile in sync with the system.", - "examples": [true, false] - }, - "iap_common-schema_enabled": { - "type": "boolean", - "description": "A flag that denotes if the repository configuration is connected", - "enum": [true, false] - }, - "iap_common-schema_total": { - "type": "integer", - "description": "The total number of documents", - "minimum": 0, - "examples": [1, 5, 10, 20, 50] - }, - "iap_common-schema_type": { - "type": "string", - "description": "The type of Repository", - "enum": ["gitlab"] - }, - "iap_common-schema_hostname": { - "type": "string", - "description": "The hostname of the Respository endpoint", - "examples": ["gitlab.com"] - }, - "iap_common-schema_path": { - "type": "string", - "description": "The path of the Repository endpoint", - "examples": ["itentialopensource/pre-built-automations"] - }, - "iap_common-schema_credentials": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "An access token used to make HTTP requests", - "examples": ["uTc_P4pnMAEsLbQHmyOt"] - } - }, - "additionalProperties": false - }, - "iap_common-schema_config": { - "type": "string", - "description": "The name of the repository configuration that will be used to fetch Prebuilts", - "examples": ["@itentialopensource"] - }, - "iap_common-schema_objectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "iap_decorators-schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/redisProps/password"] - } - } - } - }, - "iap_indexes-schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "key": { - "type": "object", - "examples": [ - { - "name": 1 - } - ], - "additionalProperties": { - "type": "integer", - "enum": [-1, 1] - } - }, - "name": { - "type": "string", - "examples": ["name_1"] - }, - "background": { - "type": "boolean", - "enum": [true] - }, - "unique": { - "type": "boolean" - } - }, - "required": ["key", "background"] - }, - "iap_prebuilts-schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "@itentialopensource/aggregate-functions-for-arrays", - "@itentialopensource/cisco-nx-upgrade" - ] - }, - "version": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - }, - "description": { - "type": "string", - "examples": ["A basic description"] - }, - "author": { - "type": "string", - "examples": ["Itential Artifacts"] - }, - "license": { - "type": "string", - "examples": ["Apache-2.0"] - }, - "repository": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["local", "gitlab", "git"] - }, - "hostname": { - "type": "string", - "examples": ["gitlab.com", "localhost"] - }, - "path": { - "type": "string", - "examples": ["/itentialopensource/pre-built-automations"] - } - }, - "required": ["type"] - }, - "keywords": { - "type": "array", - "items": { - "type": "string", - "examples": ["Itential"] - } - }, - "IAPDependencies": { - "type": "object" - }, - "gitlabId": { - "type": "integer", - "examples": [17866482] - } - }, - "required": [ - "name", - "version", - "description", - "author", - "license", - "repository", - "IAPDependencies" - ], - "additionalProperties": false - }, - "manifest": { - "type": "object", - "properties": { - "bundleName": { - "type": "string", - "examples": ["aggregateFunctions"] - }, - "fingerprint": { - "type": "string", - "examples": ["5e84f892c5eab11ec2eee16d"] - }, - "createdEpoch": { - "type": "string", - "examples": ["1585772690392"] - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "examples": ["5e5ea3bd16da51d52b4a8f9f"] - }, - "name": { - "type": "string", - "examples": ["aggregateFunctions"] - }, - "type": { - "type": "string", - "enum": [ - "automation", - "forms", - "golden-config", - "integration", - "integration-model", - "json-forms", - "mop-template", - "mop-analytic-template", - "template", - "transformation", - "workflow" - ] - }, - "location": { - "type": "string", - "examples": [ - "/bundles/workflows/IAP Test Artifact Workflow.json" - ] - } - } - } - } - }, - "required": ["bundleName", "artifacts"], - "additionalProperties": false - }, - "bundles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "automation", - "forms", - "golden-config", - "integration", - "integration-model", - "json-forms", - "mop-template", - "mop-analytic-template", - "template", - "transformation", - "workflow" - ] - }, - "data": { - "type": "object" - } - }, - "required": ["type", "data"], - "additionalProperties": false - } - }, - "readme": { - "type": "string", - "examples": ["example of readme"], - "pattern": "^([\\S\\s]*)$" - } - }, - "required": ["metadata", "manifest", "bundles", "readme"], - "additionalProperties": false - }, - "iap_prebuilts-schema_readme": { - "type": "string", - "examples": ["example of readme"], - "pattern": "^([\\S\\s]*)$" - }, - "iap_prebuilts-schema_name": { - "type": "string", - "examples": [ - "@itentialopensource/aggregate-functions-for-arrays", - "@itentialopensource/cisco-nx-upgrade" - ] - }, - "iap_prebuilts-schema_version": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - }, - "iap_prebuilts-schema_description": { - "type": "string", - "examples": ["A basic description"] - }, - "iap_prebuilts-schema_author": { - "type": "string", - "examples": ["Itential Artifacts"] - }, - "iap_prebuilts-schema_license": { - "type": "string", - "examples": ["Apache-2.0"] - }, - "iap_prebuilts-schema_repository": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["local", "gitlab", "git"] - }, - "hostname": { - "type": "string", - "examples": ["gitlab.com", "localhost"] - }, - "path": { - "type": "string", - "examples": ["/itentialopensource/pre-built-automations"] - } - }, - "required": ["type"] - }, - "iap_prebuilts-schema_keywords": { - "type": "array", - "items": { - "type": "string", - "examples": ["Itential"] - } - }, - "iap_prebuilts-schema_IAPDependencies": { - "type": "object" - }, - "iap_profiles-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "The root schema", - "description": "The root schema comprises the entire JSON document.", - "properties": { - "uiProps": { - "type": "object", - "title": "UI Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["UI"] - }, - "layout": { - "type": "string", - "title": "Layout", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/layout.jade" - ] - }, - "home": { - "type": "string", - "title": "Home", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/home.jade" - ] - }, - "login": { - "type": "string", - "title": "Login", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/login.jade" - ] - }, - "profile": { - "type": "string", - "title": "Profile", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/profile.jade" - ] - }, - "fav_icon": { - "type": "string", - "title": "Favicon", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/img/favicon.ico" - ] - } - } - }, - "authenticationProps": { - "type": "object", - "title": "Authentication Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Authentication"] - }, - "logoutTime": { - "type": "integer", - "minimum": 2, - "description": "The maximum number of time IAP has to make an api call before the user is logged out, in minutes.", - "title": "Logout Time", - "examples": [20] - }, - "uniqueSession": { - "type": "boolean", - "description": "When uniqueSession is set to true, only one session may be enabled for a given user.", - "title": "Unique Session", - "examples": [false] - }, - "admins": { - "type": "array", - "title": "Admins", - "description": "Members of these groups will be implicitly assigned with admin permissions", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "description": "The name of the AAA adapter in which the groups reside.", - "title": "Provenance", - "examples": ["Local AAA"] - }, - "group": { - "type": "string", - "description": "The name of a user group which will have Pronghorn user management capabilities.", - "title": "Group", - "examples": ["admin"] - } - } - } - }, - "cookieName": { - "type": "string", - "description": "The name used by Pronghorn to identify cookies for user session data", - "title": "Cookie Name", - "examples": ["pronghorn_token"] - }, - "brokerPrincipal": { - "type": "boolean", - "description": "When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal.", - "title": "Broker Principal", - "examples": [false] - } - } - }, - "expressProps": { - "type": "object", - "title": "Express Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Express Server"] - }, - "cacheControl": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers.", - "title": "Cache Control", - "examples": [false] - }, - "timeout": { - "type": "integer", - "description": "The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client.", - "title": "Timeout", - "examples": [300000] - }, - "access_control_allow_origin": { - "type": "string", - "description": "The configured domain name for the Access-Control-Allow-Origin header used for security.", - "title": "Access-Control-Allow-Origin", - "examples": ["*"] - }, - "express_http": { - "type": "object", - "title": "Express HTTP Settings", - "properties": { - "enable": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests.", - "title": "Enable HTTP", - "examples": [false] - }, - "port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - } - } - }, - "express_https": { - "type": "object", - "title": "Express HTTPS Settings", - "properties": { - "enable": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests.", - "title": "Enable HTTPS", - "examples": [true] - }, - "port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - }, - "key": { - "type": "string", - "description": "The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property.", - "title": "Key", - "examples": ["/opt/pronghorn/current/keys/key.pem"] - }, - "passphrase": { - "type": "string", - "title": "Passphrase", - "description": "The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase." - }, - "cert": { - "type": "string", - "title": "Certificate", - "description": "The server's public certificate to use for all HTTPS transactions.", - "examples": ["/opt/pronghorn/current/keys/cert.pem"] - }, - "secureProtocol": { - "type": "string", - "description": "The secureProtocol can be used to configure the set of allowed SSL/TLS protocol versions.", - "title": "Secure Protocol", - "examples": ["TLSv1_2_method"], - "enum": ["TLSv1_method", "TLSv1_1_method", "TLSv1_2_method"] - }, - "ciphers": { - "type": "string", - "description": "The set of ciphers to allow when establishing an encrypted session.", - "title": "Ciphers", - "examples": [ - "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" - ] - }, - "client_reneg_limit": { - "type": "integer", - "description": "The maximum number of client renegotiations allowed per renegotiation window.", - "title": "Client Renegotiation Limit", - "examples": [1] - }, - "client_reneg_window": { - "type": "integer", - "description": "The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds.", - "title": "Client Renegotiation Window", - "examples": [600] - } - } - }, - "allowedHttpOptionalVerbs": { - "title": "Allowed HTTP Optional Verbs", - "description": "An array of optional HTTP verbs that are allowed to be used in requests to IAP", - "type": "array", - "uniqueItems": true, - "items": { - "enum": [ - "ACL", - "BIND", - "CHECKOUT", - "CONNECT", - "COPY", - "LINK", - "LOCK", - "MERGE", - "MKACTIVITY", - "MKCALENDAR", - "MKCOL", - "MOVE", - "M-SEARCH", - "NOTIFY", - "PROPFIND", - "PROPPATCH", - "PURGE", - "REBIND", - "REPORT", - "SEARCH", - "SUBSCRIBE", - "TRACE", - "UNBIND", - "UNLINK", - "UNLOCK", - "UNSUBSCRIBE" - ] - } - } - } - }, - "loggerProps": { - "type": "object", - "title": "Logger Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Logging"] - }, - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store Pronghorn log files.", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name of the current Pronghorn log file.", - "title": "Filename", - "examples": ["pronghorn.log"] - }, - "log_max_file_size": { - "type": "integer", - "title": "Max File Size", - "description": "The maximum size of each Pronghorn log file in bytes.", - "examples": [1048576] - }, - "log_max_files": { - "type": "integer", - "description": "The maximum number of log files maintained on the server.", - "title": "Max Number of Files", - "examples": [100] - }, - "log_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "console_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "webserver": { - "type": "object", - "description": "Determines how to set up the web server access log.", - "title": "Webserver", - "properties": { - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store web server access log files.", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name for the web server access log file.", - "title": "Filename", - "examples": ["webserver.log"] - } - } - }, - "syslog": { - "type": "object", - "description": "Allows Pronghorn to send log messages to a local or remote syslog daemon.", - "title": "Syslog", - "properties": { - "level": { - "type": "string", - "title": "Sys Log Level", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "host": { - "type": "string", - "description": "The host running syslogd.", - "title": "Host", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "description": "The port on the host that syslog is running on.", - "title": "Port", - "minimum": 1, - "maximum": 65535, - "examples": [514] - }, - "protocol": { - "type": "string", - "title": "Protocol", - "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", - "examples": ["udp4"], - "enum": ["tcp4", "udp4", "unix", "unix-connect"] - }, - "facility": { - "type": "string", - "description": "The syslog facility to use.", - "title": "Facility", - "examples": ["local0"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", - "examples": ["5424"], - "enum": ["BSD", "5424"] - }, - "path": { - "type": "string", - "title": "Path", - "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured.", - "format": "uri-reference", - "examples": ["/dev/log"] - }, - "pid": { - "type": "string", - "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", - "title": "Process ID", - "examples": ["process.pid"] - }, - "localhost": { - "type": "string", - "description": "The host to indicate that log messages are coming from.", - "title": "Log Host", - "examples": ["localhost"] - }, - "app_name": { - "type": "string", - "description": "The name of the application.", - "title": "Application Name", - "examples": ["process.title"] - }, - "eol": { - "type": "string", - "title": "End of Line Character", - "description": "The end of line character to be added to the end of the message.", - "examples": ["CR"] - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "redisProps": { - "type": "object", - "title": "Redis Properties", - "properties": { - "db": { - "type": "integer", - "description": "The Redis database number to connect to (may be any of 0-15).", - "title": "Database Number", - "examples": [0], - "minimum": 0 - }, - "username": { - "type": "string", - "title": "Username", - "description": "The username with access to the Redis DB.", - "examples": ["admin"] - }, - "password": { - "type": "string", - "title": "Password", - "description": "The passphrase protecting access to the Redis DB.", - "examples": [ - "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e" - ] - }, - "maxRetriesPerRequest": { - "type": "integer", - "description": "IAP will be shutdown after maxRetriesPerRequest is reached in case of lost Redis network connection.", - "title": "Max Retries Per Request", - "examples": [20] - }, - "maxHeartbeatWriteRetries": { - "type": "integer", - "description": "IAP will be shutdown after maxHeartbeatWriteRetries is reached in case of lost ability to write data in Redis.", - "title": "Max Heartbeat Write Retries", - "examples": [20] - } - }, - "oneOf": [ - { - "properties": { - "host": { - "type": "string", - "description": "The IP or hostname of the server running the Redis service.", - "title": "Host", - "examples": ["127.0.0.1", "localhost", "::1"] - }, - "port": { - "type": "integer", - "title": "Port", - "examples": [6379] - } - }, - "required": ["host", "port"] - }, - { - "properties": { - "sentinels": { - "type": "array", - "title": "Sentinels", - "items": { - "type": "object", - "properties": { - "host": { - "type": "string", - "title": "Host", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "title": "Port", - "examples": [26379] - } - } - }, - "description": "The list of Redis hosts for sentinel configuration." - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the master node in the Redis sentinel group." - } - }, - "required": ["sentinels", "name"] - } - ] - }, - "auditProps": { - "type": "object", - "title": "Audit Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Audit"] - }, - "audit": { - "type": "boolean", - "title": "Audit", - "examples": [true] - }, - "brokerValidation": { - "type": "boolean", - "title": "Broker Validation", - "examples": [true] - } - } - }, - "pathProps": { - "type": "object", - "title": "Path Properties", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "encrypted": { - "type": "boolean", - "description": "A boolean flag indicating Pronghorn core is encrypted.", - "title": "Encrypted", - "examples": [true] - } - } - }, - "alarmProps": { - "title": "Alarm Properties", - "type": "array", - "items": { - "type": "object", - "title": "Remote SNMP Config", - "description": "Remote SNMP destination config.", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "ip": { - "type": "string", - "format": "hostname", - "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", - "title": "Remote Server IP Address", - "examples": ["127.0.0.1"] - }, - "community": { - "type": "string", - "description": "The SNMP community to apply to the outgoing trap or inform.", - "title": "SNMP Community", - "examples": ["public"] - }, - "properties": { - "type": "object", - "properties": { - "retries": { - "type": "integer", - "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", - "title": "Retries", - "examples": [1] - }, - "timeout": { - "type": "integer", - "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", - "title": "Timeout", - "examples": [5000] - }, - "transport": { - "type": "string", - "description": "The protocol to use to send alarms to this receiver.", - "title": "Transport Protocol", - "examples": ["udp4"], - "enum": ["udp4", "udp6"] - }, - "trapPort": { - "type": "integer", - "description": "The remote port of this alarm receiver.", - "title": "SNMP Trap Port", - "examples": [162] - }, - "version": { - "type": "string", - "description": "The SNMP version to use when delivering notifications to this alarm receiver.", - "title": "SNMP Version", - "examples": ["V1"], - "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] - } - } - }, - "type": { - "type": "string", - "description": "The type can be configured as either a trap or inform.", - "title": "SNMP Type", - "examples": ["trap", "inform"], - "enum": ["trap", "inform"] - } - }, - "additionalProperties": false - }, - "minItems": 0 - }, - "id": { - "type": "string", - "title": "Profile ID", - "pattern": "^[^\\/]+$", - "examples": ["profile1"] - }, - "services": { - "type": "array", - "title": "Services", - "items": { - "type": "string", - "examples": ["WorkflowBuilder", "FormBuilder"] - } - }, - "description": { - "type": "string", - "title": "Description", - "examples": ["An IAP Profile"] - }, - "adapterStrategy": { - "type": "object", - "title": "Adapter Strategy", - "properties": { - "device": { - "title": "Device Calls", - "description": "Defines the order in which southbound systems are called.", - "properties": { - "adapterTypes": { - "type": "array", - "uniqueItems": true, - "title": "Adapter Types", - "description": "A list of adapter types that manages the devices.", - "items": { - "type": "string", - "enum": ["NSO", "AutomationGateway"] - } - }, - "exceptions": { - "type": "object", - "maxProperties": 1, - "title": "Exceptions", - "description": "An override for the runCommand's preference to a southbound system.", - "properties": { - "runCommand": { - "type": "string", - "title": "Run Command", - "description": "Runs a command on a device.", - "oneOf": [ - { - "const": "", - "title": "None" - }, - { - "const": "NSO", - "title": "NSO" - }, - { - "const": "AutomationGateway", - "title": "Automation Gateway" - } - ] - } - } - } - }, - "type": "object" - } - }, - "additionalProperties": true - }, - "systemProps": { - "type": "object", - "title": "System Properties", - "description": "Properties used to configure IAP process.", - "properties": { - "shutdownTimeout": { - "type": "integer", - "title": "Shutdown Timeout", - "minimum": 0, - "description": "The amount of time a service should wait before shutting down, in seconds.", - "examples": [3] - }, - "servicesBlacklist": { - "type": "array", - "title": "Services Blacklist", - "description": "An array of services that blocks CRUD operation access for each service listed.", - "items": { - "type": "string", - "description": "The service type that will be denied CRUD operation access.", - "examples": ["Local AAA"] - } - }, - "launchDelay": { - "type": "integer", - "title": "Launch Delay", - "minimum": 0, - "maximum": 60, - "description": "The application/adapter launch delay, in seconds.", - "examples": [5] - }, - "launchTimeout": { - "type": "integer", - "title": "Launch Timeout", - "minimum": 30, - "maximum": 1200, - "description": "The application/adapter launch timeout, in seconds.", - "examples": [60] - }, - "serviceHealthCheckInterval": { - "type": "integer", - "title": "Service Health Check Interval", - "minimum": 1, - "description": "How often to update service health, measured in seconds." - }, - "serviceHealthCheckUnhealthyThreshold": { - "type": "integer", - "title": "Service Health Check Unhealthy Threshold", - "minimum": 1, - "description": "Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline." - }, - "deadProcessCheck": { - "type": "boolean", - "title": "Dead Process Check", - "description": "Enable/disable IAP check for dead applications/adapters.", - "examples": [false, true] - }, - "deadProcessCheckInterval": { - "type": "integer", - "title": "Dead Process Check Interval", - "minimum": 5, - "maximum": 600, - "description": "How often to check if application/adapter stopped sending healthcheck pings, in seconds.", - "examples": [5] - }, - "deadProcessMaxPeriod": { - "type": "integer", - "title": "Dead Process Max Period", - "minimum": 15, - "maximum": 600, - "description": "Maximum time period for application/adapter without sending healthcheck ping, in seconds.", - "examples": [15] - }, - "externalRequestTimeout": { - "type": "integer", - "title": "External Request Timeout", - "minimum": 1, - "maximum": 120, - "description": "The timeout for external API requests, in seconds.", - "examples": [5, 10] - }, - "deviceCountPollingInterval": { - "type": "integer", - "title": "Device Count Polling Interval", - "minimum": 1, - "maximum": 168, - "description": "The interval for how often IAP polls for the number of devices, in hours.", - "examples": [24] - } - } - }, - "prebuiltProps": { - "type": "object", - "title": "Prebuilt Properties", - "properties": { - "repoConfigs": { - "type": "object", - "title": "Repository Configurations", - "description": "The configurations used to fetch Prebuilts from different repositories.", - "properties": { - "@itentialopensource": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "A flag that denotes if the repository configuration is connected", - "enum": [true, false] - }, - "type": { - "type": "string", - "description": "The type of Repository", - "enum": ["gitlab"] - }, - "hostname": { - "type": "string", - "description": "The hostname of the Respository endpoint", - "examples": ["gitlab.com"] - }, - "path": { - "type": "string", - "description": "The path of the Repository endpoint", - "examples": ["itentialopensource/pre-built-automations"] - }, - "credentials": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "An access token used to make HTTP requests", - "examples": ["uTc_P4pnMAEsLbQHmyOt"] - } - }, - "additionalProperties": false - } - } - } - }, - "additionalProperties": true - } - } - }, - "integrationProps": { - "type": "object", - "title": "Integration Properties", - "properties": { - "threadCount": { - "type": "integer", - "title": "Integrations Thread Count", - "minimum": 1, - "maximum": 16, - "description": "The number of threads available for API requests.", - "examples": [5] - }, - "timeout": { - "type": "integer", - "title": "Integrations Timeout", - "description": "The number of milliseconds until an integration request times out.", - "examples": [15000] - } - } - }, - "retryStrategy": { - "type": "object", - "title": "Retry Strategy", - "description": "Properties used to configure the strategy services use on crash.", - "properties": { - "maxRetries": { - "type": "integer", - "title": "Max Retries", - "minimum": 1, - "description": "Specifies the amount of times services will retry on crash before stopping.", - "examples": [5] - }, - "retryResetTimer": { - "type": "integer", - "title": "Retry Reset Timer", - "minimum": 0, - "description": "Specifies the amount of times between each retry before the count will reset in milliseconds.", - "examples": [30000] - } - } - }, - "serviceDirectory": { - "type": "string", - "title": "Service Directory", - "description": "Directory at which to find additional services." - } - }, - "additionalProperties": true - }, - "iap_profiles-schema_snmpConfig": { - "type": "object", - "title": "Remote SNMP Config", - "description": "Remote SNMP destination config.", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "ip": { - "type": "string", - "format": "hostname", - "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", - "title": "Remote Server IP Address", - "examples": ["127.0.0.1"] - }, - "community": { - "type": "string", - "description": "The SNMP community to apply to the outgoing trap or inform.", - "title": "SNMP Community", - "examples": ["public"] - }, - "properties": { - "type": "object", - "properties": { - "retries": { - "type": "integer", - "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", - "title": "Retries", - "examples": [1] - }, - "timeout": { - "type": "integer", - "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", - "title": "Timeout", - "examples": [5000] - }, - "transport": { - "type": "string", - "description": "The protocol to use to send alarms to this receiver.", - "title": "Transport Protocol", - "examples": ["udp4"], - "enum": ["udp4", "udp6"] - }, - "trapPort": { - "type": "integer", - "description": "The remote port of this alarm receiver.", - "title": "SNMP Trap Port", - "examples": [162] - }, - "version": { - "type": "string", - "description": "The SNMP version to use when delivering notifications to this alarm receiver.", - "title": "SNMP Version", - "examples": ["V1"], - "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] - } - } - }, - "type": { - "type": "string", - "description": "The type can be configured as either a trap or inform.", - "title": "SNMP Type", - "examples": ["trap", "inform"], - "enum": ["trap", "inform"] - } - }, - "additionalProperties": false - }, - "iap_profiles-schema_log_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "iap_profiles-schema_sys_log_level": { - "type": "string", - "title": "Sys Log Level", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "iap_profiles-schema_port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - }, - "iap_profiles-schema_uiProps": { - "type": "object", - "title": "UI Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["UI"] - }, - "layout": { - "type": "string", - "title": "Layout", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/layout.jade" - ] - }, - "home": { - "type": "string", - "title": "Home", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/home.jade" - ] - }, - "login": { - "type": "string", - "title": "Login", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/login.jade" - ] - }, - "profile": { - "type": "string", - "title": "Profile", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/profile.jade" - ] - }, - "fav_icon": { - "type": "string", - "title": "Favicon", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/img/favicon.ico" - ] - } - } - }, - "iap_profiles-schema_authenticationProps": { - "type": "object", - "title": "Authentication Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Authentication"] - }, - "logoutTime": { - "type": "integer", - "minimum": 2, - "description": "The maximum number of time IAP has to make an api call before the user is logged out, in minutes.", - "title": "Logout Time", - "examples": [20] - }, - "uniqueSession": { - "type": "boolean", - "description": "When uniqueSession is set to true, only one session may be enabled for a given user.", - "title": "Unique Session", - "examples": [false] - }, - "admins": { - "type": "array", - "title": "Admins", - "description": "Members of these groups will be implicitly assigned with admin permissions", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "description": "The name of the AAA adapter in which the groups reside.", - "title": "Provenance", - "examples": ["Local AAA"] - }, - "group": { - "type": "string", - "description": "The name of a user group which will have Pronghorn user management capabilities.", - "title": "Group", - "examples": ["admin"] - } - } - } - }, - "cookieName": { - "type": "string", - "description": "The name used by Pronghorn to identify cookies for user session data", - "title": "Cookie Name", - "examples": ["pronghorn_token"] - }, - "brokerPrincipal": { - "type": "boolean", - "description": "When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal.", - "title": "Broker Principal", - "examples": [false] - } - } - }, - "iap_profiles-schema_expressProps": { - "type": "object", - "title": "Express Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Express Server"] - }, - "cacheControl": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers.", - "title": "Cache Control", - "examples": [false] - }, - "timeout": { - "type": "integer", - "description": "The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client.", - "title": "Timeout", - "examples": [300000] - }, - "access_control_allow_origin": { - "type": "string", - "description": "The configured domain name for the Access-Control-Allow-Origin header used for security.", - "title": "Access-Control-Allow-Origin", - "examples": ["*"] - }, - "express_http": { - "type": "object", - "title": "Express HTTP Settings", - "properties": { - "enable": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests.", - "title": "Enable HTTP", - "examples": [false] - }, - "port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - } - } - }, - "express_https": { - "type": "object", - "title": "Express HTTPS Settings", - "properties": { - "enable": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests.", - "title": "Enable HTTPS", - "examples": [true] - }, - "port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - }, - "key": { - "type": "string", - "description": "The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property.", - "title": "Key", - "examples": ["/opt/pronghorn/current/keys/key.pem"] - }, - "passphrase": { - "type": "string", - "title": "Passphrase", - "description": "The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase." - }, - "cert": { - "type": "string", - "title": "Certificate", - "description": "The server's public certificate to use for all HTTPS transactions.", - "examples": ["/opt/pronghorn/current/keys/cert.pem"] - }, - "secureProtocol": { - "type": "string", - "description": "The secureProtocol can be used to configure the set of allowed SSL/TLS protocol versions.", - "title": "Secure Protocol", - "examples": ["TLSv1_2_method"], - "enum": ["TLSv1_method", "TLSv1_1_method", "TLSv1_2_method"] - }, - "ciphers": { - "type": "string", - "description": "The set of ciphers to allow when establishing an encrypted session.", - "title": "Ciphers", - "examples": [ - "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" - ] - }, - "client_reneg_limit": { - "type": "integer", - "description": "The maximum number of client renegotiations allowed per renegotiation window.", - "title": "Client Renegotiation Limit", - "examples": [1] - }, - "client_reneg_window": { - "type": "integer", - "description": "The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds.", - "title": "Client Renegotiation Window", - "examples": [600] - } - } - }, - "allowedHttpOptionalVerbs": { - "title": "Allowed HTTP Optional Verbs", - "description": "An array of optional HTTP verbs that are allowed to be used in requests to IAP", - "type": "array", - "uniqueItems": true, - "items": { - "enum": [ - "ACL", - "BIND", - "CHECKOUT", - "CONNECT", - "COPY", - "LINK", - "LOCK", - "MERGE", - "MKACTIVITY", - "MKCALENDAR", - "MKCOL", - "MOVE", - "M-SEARCH", - "NOTIFY", - "PROPFIND", - "PROPPATCH", - "PURGE", - "REBIND", - "REPORT", - "SEARCH", - "SUBSCRIBE", - "TRACE", - "UNBIND", - "UNLINK", - "UNLOCK", - "UNSUBSCRIBE" - ] - } - } - } - }, - "iap_profiles-schema_loggerProps": { - "type": "object", - "title": "Logger Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Logging"] - }, - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store Pronghorn log files.", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name of the current Pronghorn log file.", - "title": "Filename", - "examples": ["pronghorn.log"] - }, - "log_max_file_size": { - "type": "integer", - "title": "Max File Size", - "description": "The maximum size of each Pronghorn log file in bytes.", - "examples": [1048576] - }, - "log_max_files": { - "type": "integer", - "description": "The maximum number of log files maintained on the server.", - "title": "Max Number of Files", - "examples": [100] - }, - "log_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "console_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "webserver": { - "type": "object", - "description": "Determines how to set up the web server access log.", - "title": "Webserver", - "properties": { - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store web server access log files.", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name for the web server access log file.", - "title": "Filename", - "examples": ["webserver.log"] - } - } - }, - "syslog": { - "type": "object", - "description": "Allows Pronghorn to send log messages to a local or remote syslog daemon.", - "title": "Syslog", - "properties": { - "level": { - "type": "string", - "title": "Sys Log Level", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "host": { - "type": "string", - "description": "The host running syslogd.", - "title": "Host", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "description": "The port on the host that syslog is running on.", - "title": "Port", - "minimum": 1, - "maximum": 65535, - "examples": [514] - }, - "protocol": { - "type": "string", - "title": "Protocol", - "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", - "examples": ["udp4"], - "enum": ["tcp4", "udp4", "unix", "unix-connect"] - }, - "facility": { - "type": "string", - "description": "The syslog facility to use.", - "title": "Facility", - "examples": ["local0"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", - "examples": ["5424"], - "enum": ["BSD", "5424"] - }, - "path": { - "type": "string", - "title": "Path", - "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured.", - "format": "uri-reference", - "examples": ["/dev/log"] - }, - "pid": { - "type": "string", - "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", - "title": "Process ID", - "examples": ["process.pid"] - }, - "localhost": { - "type": "string", - "description": "The host to indicate that log messages are coming from.", - "title": "Log Host", - "examples": ["localhost"] - }, - "app_name": { - "type": "string", - "description": "The name of the application.", - "title": "Application Name", - "examples": ["process.title"] - }, - "eol": { - "type": "string", - "title": "End of Line Character", - "description": "The end of line character to be added to the end of the message.", - "examples": ["CR"] - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "iap_profiles-schema_redisProps": { - "type": "object", - "title": "Redis Properties", - "properties": { - "db": { - "type": "integer", - "description": "The Redis database number to connect to (may be any of 0-15).", - "title": "Database Number", - "examples": [0], - "minimum": 0 - }, - "username": { - "type": "string", - "title": "Username", - "description": "The username with access to the Redis DB.", - "examples": ["admin"] - }, - "password": { - "type": "string", - "title": "Password", - "description": "The passphrase protecting access to the Redis DB.", - "examples": ["$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e"] - }, - "maxRetriesPerRequest": { - "type": "integer", - "description": "IAP will be shutdown after maxRetriesPerRequest is reached in case of lost Redis network connection.", - "title": "Max Retries Per Request", - "examples": [20] - }, - "maxHeartbeatWriteRetries": { - "type": "integer", - "description": "IAP will be shutdown after maxHeartbeatWriteRetries is reached in case of lost ability to write data in Redis.", - "title": "Max Heartbeat Write Retries", - "examples": [20] - } - }, - "oneOf": [ - { - "properties": { - "host": { - "type": "string", - "description": "The IP or hostname of the server running the Redis service.", - "title": "Host", - "examples": ["127.0.0.1", "localhost", "::1"] - }, - "port": { - "type": "integer", - "title": "Port", - "examples": [6379] - } - }, - "required": ["host", "port"] - }, - { - "properties": { - "sentinels": { - "type": "array", - "title": "Sentinels", - "items": { - "type": "object", - "properties": { - "host": { - "type": "string", - "title": "Host", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "title": "Port", - "examples": [26379] - } - } - }, - "description": "The list of Redis hosts for sentinel configuration." - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the master node in the Redis sentinel group." - } - }, - "required": ["sentinels", "name"] - } - ] - }, - "iap_profiles-schema_auditProps": { - "type": "object", - "title": "Audit Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Audit"] - }, - "audit": { - "type": "boolean", - "title": "Audit", - "examples": [true] - }, - "brokerValidation": { - "type": "boolean", - "title": "Broker Validation", - "examples": [true] - } - } - }, - "iap_profiles-schema_pathProps": { - "type": "object", - "title": "Path Properties", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "encrypted": { - "type": "boolean", - "description": "A boolean flag indicating Pronghorn core is encrypted.", - "title": "Encrypted", - "examples": [true] - } - } - }, - "iap_profiles-schema_alarmProps": { - "title": "Alarm Properties", - "type": "array", - "items": { - "type": "object", - "title": "Remote SNMP Config", - "description": "Remote SNMP destination config.", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "ip": { - "type": "string", - "format": "hostname", - "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", - "title": "Remote Server IP Address", - "examples": ["127.0.0.1"] - }, - "community": { - "type": "string", - "description": "The SNMP community to apply to the outgoing trap or inform.", - "title": "SNMP Community", - "examples": ["public"] - }, - "properties": { - "type": "object", - "properties": { - "retries": { - "type": "integer", - "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", - "title": "Retries", - "examples": [1] - }, - "timeout": { - "type": "integer", - "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", - "title": "Timeout", - "examples": [5000] - }, - "transport": { - "type": "string", - "description": "The protocol to use to send alarms to this receiver.", - "title": "Transport Protocol", - "examples": ["udp4"], - "enum": ["udp4", "udp6"] - }, - "trapPort": { - "type": "integer", - "description": "The remote port of this alarm receiver.", - "title": "SNMP Trap Port", - "examples": [162] - }, - "version": { - "type": "string", - "description": "The SNMP version to use when delivering notifications to this alarm receiver.", - "title": "SNMP Version", - "examples": ["V1"], - "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] - } - } - }, - "type": { - "type": "string", - "description": "The type can be configured as either a trap or inform.", - "title": "SNMP Type", - "examples": ["trap", "inform"], - "enum": ["trap", "inform"] - } - }, - "additionalProperties": false - }, - "minItems": 0 - }, - "iap_profiles-schema_id": { - "type": "string", - "title": "Profile ID", - "pattern": "^[^\\/]+$", - "examples": ["profile1"] - }, - "iap_profiles-schema_services": { - "type": "array", - "title": "Services", - "items": { - "type": "string", - "examples": ["WorkflowBuilder", "FormBuilder"] - } - }, - "iap_profiles-schema_description": { - "type": "string", - "title": "Description", - "examples": ["An IAP Profile"] - }, - "iap_profiles-schema_adapterStrategy": { - "type": "object", - "title": "Adapter Strategy", - "properties": { - "device": { - "title": "Device Calls", - "description": "Defines the order in which southbound systems are called.", - "properties": { - "adapterTypes": { - "type": "array", - "uniqueItems": true, - "title": "Adapter Types", - "description": "A list of adapter types that manages the devices.", - "items": { - "type": "string", - "enum": ["NSO", "AutomationGateway"] - } - }, - "exceptions": { - "type": "object", - "maxProperties": 1, - "title": "Exceptions", - "description": "An override for the runCommand's preference to a southbound system.", - "properties": { - "runCommand": { - "type": "string", - "title": "Run Command", - "description": "Runs a command on a device.", - "oneOf": [ - { - "const": "", - "title": "None" - }, - { - "const": "NSO", - "title": "NSO" - }, - { - "const": "AutomationGateway", - "title": "Automation Gateway" - } - ] - } - } - } - }, - "type": "object" - } - }, - "additionalProperties": true - }, - "iap_profiles-schema_systemProps": { - "type": "object", - "title": "System Properties", - "description": "Properties used to configure IAP process.", - "properties": { - "shutdownTimeout": { - "type": "integer", - "title": "Shutdown Timeout", - "minimum": 0, - "description": "The amount of time a service should wait before shutting down, in seconds.", - "examples": [3] - }, - "servicesBlacklist": { - "type": "array", - "title": "Services Blacklist", - "description": "An array of services that blocks CRUD operation access for each service listed.", - "items": { - "type": "string", - "description": "The service type that will be denied CRUD operation access.", - "examples": ["Local AAA"] - } - }, - "launchDelay": { - "type": "integer", - "title": "Launch Delay", - "minimum": 0, - "maximum": 60, - "description": "The application/adapter launch delay, in seconds.", - "examples": [5] - }, - "launchTimeout": { - "type": "integer", - "title": "Launch Timeout", - "minimum": 30, - "maximum": 1200, - "description": "The application/adapter launch timeout, in seconds.", - "examples": [60] - }, - "serviceHealthCheckInterval": { - "type": "integer", - "title": "Service Health Check Interval", - "minimum": 1, - "description": "How often to update service health, measured in seconds." - }, - "serviceHealthCheckUnhealthyThreshold": { - "type": "integer", - "title": "Service Health Check Unhealthy Threshold", - "minimum": 1, - "description": "Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline." - }, - "deadProcessCheck": { - "type": "boolean", - "title": "Dead Process Check", - "description": "Enable/disable IAP check for dead applications/adapters.", - "examples": [false, true] - }, - "deadProcessCheckInterval": { - "type": "integer", - "title": "Dead Process Check Interval", - "minimum": 5, - "maximum": 600, - "description": "How often to check if application/adapter stopped sending healthcheck pings, in seconds.", - "examples": [5] - }, - "deadProcessMaxPeriod": { - "type": "integer", - "title": "Dead Process Max Period", - "minimum": 15, - "maximum": 600, - "description": "Maximum time period for application/adapter without sending healthcheck ping, in seconds.", - "examples": [15] - }, - "externalRequestTimeout": { - "type": "integer", - "title": "External Request Timeout", - "minimum": 1, - "maximum": 120, - "description": "The timeout for external API requests, in seconds.", - "examples": [5, 10] - }, - "deviceCountPollingInterval": { - "type": "integer", - "title": "Device Count Polling Interval", - "minimum": 1, - "maximum": 168, - "description": "The interval for how often IAP polls for the number of devices, in hours.", - "examples": [24] - } - } - }, - "iap_profiles-schema_integrationProps": { - "type": "object", - "title": "Integration Properties", - "properties": { - "threadCount": { - "type": "integer", - "title": "Integrations Thread Count", - "minimum": 1, - "maximum": 16, - "description": "The number of threads available for API requests.", - "examples": [5] - }, - "timeout": { - "type": "integer", - "title": "Integrations Timeout", - "description": "The number of milliseconds until an integration request times out.", - "examples": [15000] - } - } - }, - "iap_profiles-schema_retryStrategy": { - "type": "object", - "title": "Retry Strategy", - "description": "Properties used to configure the strategy services use on crash.", - "properties": { - "maxRetries": { - "type": "integer", - "title": "Max Retries", - "minimum": 1, - "description": "Specifies the amount of times services will retry on crash before stopping.", - "examples": [5] - }, - "retryResetTimer": { - "type": "integer", - "title": "Retry Reset Timer", - "minimum": 0, - "description": "Specifies the amount of times between each retry before the count will reset in milliseconds.", - "examples": [30000] - } - } - }, - "iap_profiles-schema_serviceDirectory": { - "type": "string", - "title": "Service Directory", - "description": "Directory at which to find additional services." - }, - "iap_services-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Services Schema", - "description": "All of the properties required for a service.", - "properties": { - "loggerProps": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description property", - "title": "Description", - "default": "Logger Settings", - "examples": ["Logging"] - }, - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store Pronghorn log files.", - "default": "/var/log/pronghorn", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name of the current Pronghorn log file.", - "title": "Filename", - "default": "pronghorn.log", - "examples": ["pronghorn.log"] - }, - "log_max_file_size": { - "type": "integer", - "title": "Max File Size", - "description": "The maximum size of each Pronghorn log file in bytes.", - "default": 1048576, - "examples": [1048576] - }, - "log_max_files": { - "type": "integer", - "description": "The maximum number of log files maintained on the server.", - "title": "Max Number of Files", - "default": 100, - "examples": [100] - }, - "log_timezone_offset": { - "type": "integer", - "description": "An integer specifying the offset from GMT/UTC time that will be used when writing to the log files.", - "title": "Timezone Offset", - "default": 0, - "examples": [-5], - "minimum": -12, - "maximum": 12 - }, - "log_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "console_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "metrics_filename": { - "type": "string", - "description": "The name of the job metrics log file, if applicable.", - "title": "Metrics Filename", - "default": "metrics.log", - "examples": ["metrics.log"] - }, - "metrics_max_files": { - "type": "integer", - "description": "The maximum number of job metrics log files maintained on the server, if applicable.", - "title": "Max Number of Metrics Files", - "default": 31, - "examples": [31] - }, - "metrics_rotation_interval": { - "type": "string", - "description": "The time until the metrics log is rotated in minutes, hours, days, or weeks, if applicable.", - "title": "Rotation Interval of Metrics Files", - "default": "7d", - "examples": ["7d"] - }, - "metrics_rotation_size": { - "type": "string", - "description": "The maximum file size before the metrics log is rotated in kilobytes, megabytes, or gigabytes, if applicable.", - "title": "Rotation Size of Metrics Files", - "default": "10M", - "examples": ["10M"] - }, - "syslog": { - "type": "object", - "description": "The syslog properties allow Pronghorn to send log messages to a local or remote syslog daemon.", - "properties": { - "level": { - "type": "string", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "host": { - "type": "string", - "description": "The host running syslogd.", - "title": "Host", - "default": "localhost", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "description": "The port on the host that syslog is running on.", - "title": "Port", - "default": 514, - "minimum": 1, - "maximum": 65535, - "examples": [514] - }, - "protocol": { - "type": "string", - "title": "Protocol", - "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", - "default": "udp4", - "examples": ["udp4"], - "enum": ["tcp4", "udp4", "unix", "unix-connect"] - }, - "facility": { - "type": "string", - "description": "Syslog facility to use.", - "title": "Facility", - "default": "local0", - "examples": ["local0"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", - "default": "BSD", - "examples": ["5424"], - "enum": ["BSD", "5424"] - }, - "path": { - "type": "string", - "title": "Path", - "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X).If path is used, host, port and protocol do not need to be configured.", - "default": "", - "format": "uri-reference", - "examples": ["/dev/log"] - }, - "pid": { - "type": "string", - "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", - "title": "Process Id", - "default": "process.pid", - "examples": ["process.pid"] - }, - "localhost": { - "type": "string", - "description": "Host to indicate that log messages are coming from.", - "title": "Log Host", - "default": "", - "examples": ["localhost"] - }, - "app_name": { - "type": "string", - "description": "The name of the application.", - "title": "Application Name", - "default": "", - "examples": ["process.title"] - }, - "eol": { - "type": "string", - "title": "End of Line Character", - "description": "The end of line character to be added to the end of the message.", - "default": "", - "examples": ["CR"] - } - }, - "allOf": [ - { - "required": ["level", "facility", "type"] - }, - { - "anyOf": [ - { - "required": ["host", "port", "protocol"] - }, - { - "required": ["path"] - } - ] - } - ], - "additionalProperties": false - } - }, - "required": [ - "log_max_files", - "log_max_file_size", - "log_level", - "log_directory", - "log_filename", - "console_level" - ], - "additionalProperties": false - }, - "isEncrypted": { - "type": "boolean", - "title": "isEncrypted", - "default": false, - "description": "Whether or not this service is encrypted", - "examples": [true, false] - }, - "profiling": { - "type": "boolean", - "title": "profiling", - "default": false, - "description": "Whether or not to profile this service", - "examples": [true, false] - }, - "model": { - "type": "string", - "title": "Model", - "default": "", - "description": "The model used by the service", - "examples": ["@itential/adapter-local_aaa"], - "pattern": "^@[-_.a-z]+/.+" - }, - "name": { - "type": "string", - "title": "Name", - "default": "", - "description": "The name of the service", - "pattern": "^[^\\/]+$", - "examples": ["Local AAA"] - }, - "type": { - "type": "string", - "title": "Type", - "default": "Application", - "description": "If the service is an app or adapter", - "enum": ["Application", "Adapter"] - }, - "properties": { - "type": "object", - "title": "Properties", - "description": "The properties of a service", - "properties": {} - }, - "virtual": { - "type": "boolean", - "title": "virtual", - "default": false, - "description": "Whether or not this service is an Integration.", - "examples": [true, false] - }, - "systemProps": { - "type": "object", - "title": "System Properties", - "description": "Properties used to configure IAP process.", - "properties": { - "maxOldSpaceSize": { - "type": "number", - "title": "maxOldSpaceSize", - "description": "Sets the limit heap memory size on service child process.", - "minimum": 100, - "examples": [2048, 1024] - } - } - }, - "eventDeduplication": { - "type": "object", - "title": "eventDeduplication", - "description": "Properties used by the event-system to deduplicate events", - "required": ["active", "cacheTtl", "uniqueProps"], - "properties": { - "active": { - "type": "boolean", - "description": "Whether or not event deduplication is configured", - "title": "Active" - }, - "cacheTtl": { - "type": "integer", - "description": "The time to live set up for event deduplication", - "title": "Cache Ttl", - "examples": [10000] - }, - "uniqueProps": { - "type": "array", - "description": "Unique properties set up in event deduplication", - "title": "Unique Props", - "items": { - "type": "string", - "examples": ["/messageId"] - } - } - } - } - }, - "oneOf": [ - { - "properties": { - "type": { - "const": "Application" - }, - "properties": { - "properties": {} - } - } - }, - { - "properties": { - "type": { - "const": "Adapter" - }, - "properties": { - "properties": { - "id": { - "type": "string", - "title": "id", - "default": "", - "description": "The id for the service", - "const": { - "$data": "2/name" - }, - "examples": ["Local AAA"] - }, - "type": { - "type": "string", - "title": "Type", - "default": "", - "description": "The type of service", - "examples": ["local_aaa"] - }, - "properties": { - "type": "object", - "properties": {} - }, - "brokers": { - "type": "array", - "uniqueItems": true, - "description": "Brokers which utilize this service", - "items": { - "type": "string", - "description": "Name of the broker", - "enum": [ - "aaa", - "compliance", - "device", - "fault", - "instance", - "inventory", - "method", - "notification", - "performance", - "persistence", - "service", - "topology" - ], - "examples": ["aaa"] - } - }, - "groups": { - "type": "array", - "description": "Groups which can use this service", - "items": { - "type": "string", - "description": "The mongo id of the group", - "examples": ["5fe9f10cc1fca243d562e1d8"], - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["id", "type", "properties", "brokers", "groups"] - } - } - } - ], - "required": [ - "loggerProps", - "isEncrypted", - "model", - "name", - "type", - "properties" - ], - "additionalProperties": false - }, - "iap_services-schema_log_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "iap_services-schema_sys_log_level": { - "type": "string", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "iap_services-schema_name": { - "type": "string", - "title": "Name", - "default": "", - "description": "The name of the service", - "pattern": "^[^\\/]+$", - "examples": ["Local AAA"] - }, - "iap_services-schema_model": { - "type": "string", - "title": "Model", - "default": "", - "description": "The model used by the service", - "examples": ["@itential/adapter-local_aaa"], - "pattern": "^@[-_.a-z]+/.+" - }, - "iap_services-schema_isEncrypted": { - "type": "boolean", - "title": "isEncrypted", - "default": false, - "description": "Whether or not this service is encrypted", - "examples": [true, false] - }, - "iap_services-schema_type": { - "type": "string", - "title": "Type", - "default": "Application", - "description": "If the service is an app or adapter", - "enum": ["Application", "Adapter"] - }, - "iap_services-schema_loggerProps": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description property", - "title": "Description", - "default": "Logger Settings", - "examples": ["Logging"] - }, - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store Pronghorn log files.", - "default": "/var/log/pronghorn", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name of the current Pronghorn log file.", - "title": "Filename", - "default": "pronghorn.log", - "examples": ["pronghorn.log"] - }, - "log_max_file_size": { - "type": "integer", - "title": "Max File Size", - "description": "The maximum size of each Pronghorn log file in bytes.", - "default": 1048576, - "examples": [1048576] - }, - "log_max_files": { - "type": "integer", - "description": "The maximum number of log files maintained on the server.", - "title": "Max Number of Files", - "default": 100, - "examples": [100] - }, - "log_timezone_offset": { - "type": "integer", - "description": "An integer specifying the offset from GMT/UTC time that will be used when writing to the log files.", - "title": "Timezone Offset", - "default": 0, - "examples": [-5], - "minimum": -12, - "maximum": 12 - }, - "log_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "console_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "metrics_filename": { - "type": "string", - "description": "The name of the job metrics log file, if applicable.", - "title": "Metrics Filename", - "default": "metrics.log", - "examples": ["metrics.log"] - }, - "metrics_max_files": { - "type": "integer", - "description": "The maximum number of job metrics log files maintained on the server, if applicable.", - "title": "Max Number of Metrics Files", - "default": 31, - "examples": [31] - }, - "metrics_rotation_interval": { - "type": "string", - "description": "The time until the metrics log is rotated in minutes, hours, days, or weeks, if applicable.", - "title": "Rotation Interval of Metrics Files", - "default": "7d", - "examples": ["7d"] - }, - "metrics_rotation_size": { - "type": "string", - "description": "The maximum file size before the metrics log is rotated in kilobytes, megabytes, or gigabytes, if applicable.", - "title": "Rotation Size of Metrics Files", - "default": "10M", - "examples": ["10M"] - }, - "syslog": { - "type": "object", - "description": "The syslog properties allow Pronghorn to send log messages to a local or remote syslog daemon.", - "properties": { - "level": { - "type": "string", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "host": { - "type": "string", - "description": "The host running syslogd.", - "title": "Host", - "default": "localhost", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "description": "The port on the host that syslog is running on.", - "title": "Port", - "default": 514, - "minimum": 1, - "maximum": 65535, - "examples": [514] - }, - "protocol": { - "type": "string", - "title": "Protocol", - "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", - "default": "udp4", - "examples": ["udp4"], - "enum": ["tcp4", "udp4", "unix", "unix-connect"] - }, - "facility": { - "type": "string", - "description": "Syslog facility to use.", - "title": "Facility", - "default": "local0", - "examples": ["local0"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", - "default": "BSD", - "examples": ["5424"], - "enum": ["BSD", "5424"] - }, - "path": { - "type": "string", - "title": "Path", - "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X).If path is used, host, port and protocol do not need to be configured.", - "default": "", - "format": "uri-reference", - "examples": ["/dev/log"] - }, - "pid": { - "type": "string", - "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", - "title": "Process Id", - "default": "process.pid", - "examples": ["process.pid"] - }, - "localhost": { - "type": "string", - "description": "Host to indicate that log messages are coming from.", - "title": "Log Host", - "default": "", - "examples": ["localhost"] - }, - "app_name": { - "type": "string", - "description": "The name of the application.", - "title": "Application Name", - "default": "", - "examples": ["process.title"] - }, - "eol": { - "type": "string", - "title": "End of Line Character", - "description": "The end of line character to be added to the end of the message.", - "default": "", - "examples": ["CR"] - } - }, - "allOf": [ - { - "required": ["level", "facility", "type"] - }, - { - "anyOf": [ - { - "required": ["host", "port", "protocol"] - }, - { - "required": ["path"] - } - ] - } - ], - "additionalProperties": false - } - }, - "required": [ - "log_max_files", - "log_max_file_size", - "log_level", - "log_directory", - "log_filename", - "console_level" - ], - "additionalProperties": false - }, - "iap_services-schema_properties": { - "type": "object", - "title": "Properties", - "description": "The properties of a service", - "properties": {} - }, - "iap_services-schema_virtual": { - "type": "boolean", - "title": "virtual", - "default": false, - "description": "Whether or not this service is an Integration.", - "examples": [true, false] - }, - "iap_banner-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "The root schema", - "description": "The root schema comprises the entire JSON document.", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "active": { - "type": "boolean", - "description": "A flag indicating if the banner will be displayed to users" - }, - "text": { - "type": "string", - "description": "Text in the banner when displayed" - }, - "backgroundColor": { - "type": "string", - "description": "The background color for the banner displayed", - "examples": ["#fff"] - }, - "dismissible": { - "type": "boolean", - "description": "A flag indicating if a banner should be dismissible by users" - }, - "startTime": { - "type": "string", - "description": "An ISO Timestring value indicating when the banner will show", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "endTime": { - "type": "string", - "description": "A, ISO Timestring value indicating when the banner will no longer show", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "allPages": { - "type": "boolean", - "description": "A flag indicating if the banner should show on all pages or only the IAP home page" - }, - "image": { - "description": "A base64 image string containing the image that will be shown on the banner", - "type": "string" - }, - "messageLastUpdated": { - "type": "string", - "description": "An ISO Timestring value indicating when the banner message was last updated", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", - "examples": ["2018-08-02T15:56:12.912Z"] - } - }, - "required": ["text", "active", "startTime", "dismissible", "allPages"] - }, - "iap_authorization-common": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Common Authorization Schema" - }, - "iap_authorization-common_accounts-query": { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["john_doe"] - }, - "firstname": { - "type": "string", - "examples": ["John"] - }, - "email": { - "type": "string", - "examples": ["user@email.com"] - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - } - } - }, - "iap_authorization-common_groups-query": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["group1"] - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "description": { - "type": "string", - "examples": ["this is group1"] - } - } - }, - "iap_authorization-common_roles-query": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "examples": ["Custom"] - }, - "name": { - "type": "string", - "examples": ["role_1"] - }, - "description": { - "type": "string", - "examples": ["description of role_1"] - } - } - }, - "iap_authorization-common_roleId": { - "title": "roleId", - "type": "string", - "examples": ["Authorization.admin"] - }, - "iap_groups-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Group Schema", - "description": "This is the schema for an IAP group stored in Mongo", - "properties": { - "provenance": { - "title": "Provenance", - "description": "AAA provider where group originated", - "type": "string", - "examples": ["Local AAA", "Pronghorn"] - }, - "name": { - "title": "Name", - "description": "Name of group", - "type": "string", - "examples": ["group_1"] - }, - "description": { - "title": "Description", - "description": "Description of group", - "type": "string", - "examples": ["description of group_1"] - }, - "memberOf": { - "title": "Assigned Groups", - "description": "Parent groups which this group is a part of", - "type": "array", - "items": { - "type": "object", - "properties": { - "aaaManaged": { - "description": "Whether group comes from an external AAA or not", - "type": "boolean" - }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "assignedRoles": { - "title": "Assigned Roles", - "description": "Roles assigned to this group", - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - }, - "additionalProperties": false - } - }, - "inactive": { - "title": "Inactive", - "description": "Setting for whether group is active or not", - "type": "boolean" - }, - "_meta": { - "title": "Metadata", - "description": "Metadata for group", - "type": "object", - "properties": { - "created": { - "title": "Created", - "description": "When the group was created", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updated": { - "title": "Updated", - "description": "When the group was last updated", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - } - } - } - }, - "additionalProperties": false, - "required": [ - "provenance", - "name", - "description", - "memberOf", - "assignedRoles", - "inactive" - ] - }, - "iap_groups-schema_inactive": { - "title": "Inactive", - "description": "Setting for whether group is active or not", - "type": "boolean" - }, - "iap_groups-schema_provenance": { - "title": "Provenance", - "description": "AAA provider where group originated", - "type": "string", - "examples": ["Local AAA", "Pronghorn"] - }, - "iap_groups-schema_name": { - "title": "Name", - "description": "Name of group", - "type": "string", - "examples": ["group_1"] - }, - "iap_groups-schema_description": { - "title": "Description", - "description": "Description of group", - "type": "string", - "examples": ["description of group_1"] - }, - "iap_groups-schema_memberOf": { - "title": "Assigned Groups", - "description": "Parent groups which this group is a part of", - "type": "array", - "items": { - "type": "object", - "properties": { - "aaaManaged": { - "description": "Whether group comes from an external AAA or not", - "type": "boolean" - }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "iap_groups-schema_assignedRoles": { - "title": "Assigned Roles", - "description": "Roles assigned to this group", - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - }, - "additionalProperties": false - } - }, - "iap_roles-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Role Schema", - "description": "This is the schema for an IAP role stored in Mongo", - "properties": { - "provenance": { - "type": "string", - "examples": ["Custom"] - }, - "name": { - "type": "string", - "examples": ["role_1"] - }, - "description": { - "type": "string", - "examples": ["description of role_1"] - }, - "allowedMethods": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["methodName"] - }, - "provenance": { - "type": "string", - "examples": ["ApplicationName"] - } - } - } - }, - "allowedViews": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/manual/task/path"] - }, - "provenance": { - "type": "string", - "examples": ["ApplicationName"] - } - } - } - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updated": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - } - } - } - }, - "additionalProperties": false, - "required": [ - "provenance", - "name", - "description", - "allowedMethods", - "allowedViews" - ] - }, - "iap_roles-schema_name": { - "type": "string", - "examples": ["role_1"] - }, - "iap_roles-schema_description": { - "type": "string", - "examples": ["description of role_1"] - }, - "iap_roles-schema_allowedMethods": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["methodName"] - }, - "provenance": { - "type": "string", - "examples": ["ApplicationName"] - } - } - } - }, - "iap_roles-schema_allowedViews": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/manual/task/path"] - }, - "provenance": { - "type": "string", - "examples": ["ApplicationName"] - } - } - } - }, - "iap_system-common": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Common System Schema" - }, - "iap_system-common_methods-query": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["getAdapters"] - }, - "provenance": { - "type": "string", - "examples": ["Adapters"] - }, - "deprecated": { - "type": "boolean" - } - } - }, - "iap_system-common_views-query": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/"] - }, - "provenance": { - "type": "string", - "examples": ["WorkFlowEngine"] - } - } - }, - "iap_device-count-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Device Count History Schema", - "description": "This is the schema for an IAP device count stored in Mongo", - "properties": { - "timestamp": { - "type": "string", - "description": "An ISODate representing when the device count was taken", - "examples": ["2023-02-14T20:06:50.569Z"] - }, - "serverId": { - "type": "string", - "description": "The serverId where the device count was taken" - }, - "counts": { - "type": "object", - "description": "The key/value pair between an adapter name and the number of devices", - "additionalProperties": { - "type": "integer", - "minimum": 0 - } - } - }, - "required": ["timestamp", "serverId", "counts"], - "additionalProperties": false - }, - "iap_services-health-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "The root schema", - "description": "The root schema comprises the entire JSON document.", - "properties": { - "id": { - "type": "string", - "examples": ["AdminEssentials"] - }, - "package_id": { - "type": "string", - "title": "Model", - "default": "", - "description": "The model used by the service", - "examples": ["@itential/adapter-local_aaa"], - "pattern": "^@[-_.a-z]+/.+" - }, - "version": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - }, - "type": { - "type": "string", - "enum": ["Adapter", "Application"] - }, - "description": { - "type": "string", - "examples": ["A basic description"] - }, - "state": { - "type": "string", - "enum": ["DEAD", "STOPPED", "RUNNING", "DELETED"] - }, - "connection": { - "type": "object", - "oneOf": [ - { - "const": null - }, - { - "properties": { - "state": { - "type": "string", - "examples": ["ONLINE"] - } - } - } - ] - }, - "uptime": { - "type": "number", - "description": "Number of seconds the current process has been running.", - "examples": [2245.9722] - }, - "memoryUsage": { - "type": "object", - "properties": { - "rss": { - "type": "integer", - "description": "Resident Set Size - the amount of space occupied in the main memory - in bytes", - "examples": [7125982] - }, - "heapTotal": { - "type": "integer", - "description": "Heap Total in bytes for the Node V8 engine", - "examples": [7125982] - }, - "heapUsed": { - "type": "integer", - "description": "Heap Used in bytes by the Node V8 engine", - "examples": [7125982] - }, - "external": { - "type": "integer", - "description": "External usage - memory usage of C++ objects bound to JavaScript objects managed by the Node V8 engine - in bytes", - "examples": [7125982] - } - } - }, - "cpuUsage": { - "type": "object", - "description": "Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)", - "properties": { - "user": { - "description": "Microseconds spent in user mode", - "type": "integer", - "examples": [7125982] - }, - "system": { - "description": "Microseconds spent in system mode", - "type": "integer", - "examples": [7125982] - } - } - }, - "pid": { - "type": "integer", - "examples": [7125982] - }, - "logger": { - "type": "object", - "properties": { - "console": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "file": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "syslog": { - "type": "string", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - } - } - }, - "routePrefix": { - "type": "string", - "examples": ["admin", "search"] - }, - "prevUptime": { - "type": "number", - "examples": [2245.9722] - } - } - }, - "iap_services-health-schema_version": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - }, - "iap_services-health-schema_cpuUsage": { - "type": "object", - "description": "Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)", - "properties": { - "user": { - "description": "Microseconds spent in user mode", - "type": "integer", - "examples": [7125982] - }, - "system": { - "description": "Microseconds spent in system mode", - "type": "integer", - "examples": [7125982] - } - } - }, - "iap_services-health-schema_uptime": { - "type": "number", - "description": "Number of seconds the current process has been running.", - "examples": [2245.9722] - }, - "iap_services-health-schema_pid": { - "type": "integer", - "examples": [7125982] - }, - "iap_services-health-schema_memoryUsage": { - "type": "object", - "properties": { - "rss": { - "type": "integer", - "description": "Resident Set Size - the amount of space occupied in the main memory - in bytes", - "examples": [7125982] - }, - "heapTotal": { - "type": "integer", - "description": "Heap Total in bytes for the Node V8 engine", - "examples": [7125982] - }, - "heapUsed": { - "type": "integer", - "description": "Heap Used in bytes by the Node V8 engine", - "examples": [7125982] - }, - "external": { - "type": "integer", - "description": "External usage - memory usage of C++ objects bound to JavaScript objects managed by the Node V8 engine - in bytes", - "examples": [7125982] - } - } - }, - "iap_links-query": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential External Link Query Schema", - "description": "This is the schema for queries on IAP external links", - "properties": { - "name": { - "type": "string", - "examples": ["Google"] - }, - "address": { - "type": "string", - "examples": ["https://www.google.com/"] - }, - "description": { - "type": "string", - "examples": ["A link to Google"] - } - }, - "additionalProperties": false - }, - "iap_links-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential External Link Schema", - "description": "This is the schema for an IAP external link stored in Mongo", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "pattern": "^(?![\\s.]+$)[a-zA-Z\\s.]*$", - "examples": ["Google"] - }, - "address": { - "type": "string", - "minLength": 1, - "examples": ["https://www.google.com/"] - }, - "description": { - "type": "string", - "examples": ["A link to Google"] - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updated": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - } - } - } - }, - "required": ["name", "address"], - "additionalProperties": false - }, - "iap_links-schema_name": { - "type": "string", - "minLength": 1, - "pattern": "^(?![\\s.]+$)[a-zA-Z\\s.]*$", - "examples": ["Google"] - }, - "iap_links-schema_address": { - "type": "string", - "minLength": 1, - "examples": ["https://www.google.com/"] - }, - "iap_links-schema_description": { - "type": "string", - "examples": ["A link to Google"] - }, - "iap_repository-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Prebuilt Repository Configuration Schema", - "description": "This is the schema for a Repository Configuration used to fetch Prebuilts", - "properties": { - "enabled": {}, - "type": {}, - "hostname": {}, - "path": {}, - "credentials": {}, - "versionStatus": { - "type": "string", - "description": "The version status of the Pre-built Automation in relation to the current IAP version", - "enum": ["current", "latest"], - "default": "latest" - } - }, - "required": ["enabled", "type", "hostname", "path", "credentials"], - "additionalProperties": false - }, - "iap_repository-schema_enabled": { - "type": "boolean", - "description": "A flag that denotes if the repository configuration is connected", - "enum": [true, false] - }, - "iap_repository-schema_type": { - "type": "string", - "description": "The type of Repository", - "enum": ["gitlab"] - }, - "iap_repository-schema_hostname": { - "type": "string", - "description": "The hostname of the Respository endpoint", - "examples": ["gitlab.com"] - }, - "iap_repository-schema_path": { - "type": "string", - "description": "The path of the Repository endpoint", - "examples": ["itentialopensource/pre-built-automations"] - }, - "iap_repository-schema_credentials": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "An access token used to make HTTP requests", - "examples": ["uTc_P4pnMAEsLbQHmyOt"] - } - }, - "additionalProperties": false - }, - "iap_sso-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "SSO Schema", - "description": "Schema describing an SSO configuration object", - "properties": { - "name": { - "type": "string", - "description": "Name of the SSO configuration", - "examples": ["Auth0", "Okta"] - }, - "ssoType": { - "type": "string", - "description": "Single sign on type, SAML, OpenID, etc.", - "examples": ["saml"], - "enum": ["saml"] - }, - "settings": { - "type": "object", - "description": "The configuration for the sso type used", - "oneOf": [ - { - "type": "object", - "required": [ - "issuer", - "loginURL", - "certificate", - "samlUserNameAttribute", - "samlGroupsAttribute", - "forceLogin" - ], - "additionalProperties": false, - "properties": { - "description": { - "type": "string", - "description": "A description of the sso configuration", - "examples": ["This sso configuration connects to Okta"] - }, - "issuer": { - "type": "string", - "description": "Issuer identity provider", - "examples": ["https://www.auth0.com/oauth2/example"] - }, - "loginURL": { - "type": "string", - "description": "Login URL for SSO identity provider", - "examples": ["https://www.auth0.com/login"] - }, - "logoutURL": { - "type": "string", - "description": "Logout URL for SSO identity provider", - "examples": ["https://www.auth0.com/logout"] - }, - "certificate": { - "type": "string", - "description": "Security certificate", - "examples": [ - "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==" - ] - }, - "samlEmailAttribute": { - "type": "string", - "description": "Attribute containing user email address", - "examples": [ - "mail", - "email", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - ], - "default": "email" - }, - "samlUserNameAttribute": { - "type": "string", - "description": "Attribute containing the full user name", - "examples": [ - "userName", - "user", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" - ], - "default": "username" - }, - "samlGroupsAttribute": { - "type": "string", - "description": "Attribute containing the name of the groups property", - "examples": [ - "groups", - "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups" - ], - "default": "groups" - }, - "samlFirstNameAttribute": { - "type": "string", - "description": "Attribute containing the first name of the user", - "examples": [ - "firstName", - "name", - "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" - ] - }, - "forceLogin": { - "type": "boolean", - "description": "A boolean flag indicating if a user is forced to login", - "title": "Force User Login", - "default": false - } - } - } - ] - }, - "active": { - "description": "Whether or not the SSO Config is selected for use. For 'active' to be true, 'tested' must also be true.", - "type": "boolean", - "default": false - }, - "tested": { - "type": "boolean", - "description": "Whether the sso config was tested" - } - }, - "required": ["name", "ssoType", "settings"], - "additionalProperties": false - }, - "iap_sso-schema_samlConfig": { - "type": "object", - "required": [ - "issuer", - "loginURL", - "certificate", - "samlUserNameAttribute", - "samlGroupsAttribute", - "forceLogin" - ], - "additionalProperties": false, - "properties": { - "description": { - "type": "string", - "description": "A description of the sso configuration", - "examples": ["This sso configuration connects to Okta"] - }, - "issuer": { - "type": "string", - "description": "Issuer identity provider", - "examples": ["https://www.auth0.com/oauth2/example"] - }, - "loginURL": { - "type": "string", - "description": "Login URL for SSO identity provider", - "examples": ["https://www.auth0.com/login"] - }, - "logoutURL": { - "type": "string", - "description": "Logout URL for SSO identity provider", - "examples": ["https://www.auth0.com/logout"] - }, - "certificate": { - "type": "string", - "description": "Security certificate", - "examples": [ - "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==" - ] - }, - "samlEmailAttribute": { - "type": "string", - "description": "Attribute containing user email address", - "examples": [ - "mail", - "email", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - ], - "default": "email" - }, - "samlUserNameAttribute": { - "type": "string", - "description": "Attribute containing the full user name", - "examples": [ - "userName", - "user", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" - ], - "default": "username" - }, - "samlGroupsAttribute": { - "type": "string", - "description": "Attribute containing the name of the groups property", - "examples": [ - "groups", - "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups" - ], - "default": "groups" - }, - "samlFirstNameAttribute": { - "type": "string", - "description": "Attribute containing the first name of the user", - "examples": [ - "firstName", - "name", - "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" - ] - }, - "forceLogin": { - "type": "boolean", - "description": "A boolean flag indicating if a user is forced to login", - "title": "Force User Login", - "default": false - } - } - }, - "iap_mapping-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Group Mapping Schema", - "description": "This is the schema for an IAP group mapping stored in Mongo", - "properties": { - "externalGroup": { - "type": "string", - "description": "name of the external group" - }, - "provenance": { - "type": "string", - "description": "The AAA provider for the external group", - "examples": ["Okta"] - }, - "iapGroups": { - "type": "array", - "items": { - "type": "string", - "description": "ObjectId for the group within IAP" - } - } - }, - "required": ["externalGroup", "iapGroups", "provenance"], - "additionalProperties": false - }, - "iap_mapping-schema_iapGroups": { - "type": "array", - "items": { - "type": "string", - "description": "ObjectId for the group within IAP" - } - }, - "iap_mapping-schema_externalGroup": { - "type": "string", - "description": "name of the external group" - }, - "iap_mapping-schema_provenance": { - "type": "string", - "description": "The AAA provider for the external group", - "examples": ["Okta"] - }, - "iap_git-common": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Common Git Schema" - }, - "iap_git-common_type": { - "type": "string", - "description": "The type of Git provider being used", - "enum": ["GitHub", "GitLab"] - }, - "iap_git-common_repoPath": { - "title": "repoPath", - "description": "The path in Git to the repository", - "type": "string", - "examples": ["github-organization", "gitlabGroup%2FsubGroup"] - }, - "iap_git-common_branchName": { - "title": "branchName", - "description": "The name of the branch inside a Git repository", - "type": "string", - "examples": ["main"] - }, - "iap_git-common_projectPath": { - "title": "repoPath", - "description": "The file path within a Git repository to a project file", - "type": "string", - "examples": ["directory%2Fproject.json", "example.json"] - }, - "iap_git-common_commitMessage": { - "title": "commitMessage", - "description": "The commit message sent to Git when updating a project", - "type": "string", - "examples": ["This is an example commit message."] - }, - "iap_service-accounts-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential OAuth Service Account Schema", - "description": "This is the schema for an OAuth service account stored in Mongo", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "name": { - "type": "string", - "description": "The name associated with the service account", - "examples": ["ExampleName"] - }, - "description": { - "type": "string", - "description": "The description of the service account", - "examples": [ - "This is a service account for the external Example system" - ] - }, - "clientId": {}, - "clientSecret": { - "type": "string", - "description": "Uuid representation of client secret", - "examples": ["d4c673d6-17f8-4e76-8034-a87820f96618"] - }, - "_meta": { - "type": "object", - "properties": { - "updated": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updatedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "created": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "additionalProperties": false, - "required": ["name", "description", "clientId", "clientSecret"] - }, - "iap_service-accounts-schema_name": { - "type": "string", - "description": "The name associated with the service account", - "examples": ["ExampleName"] - }, - "iap_service-accounts-schema_description": { - "type": "string", - "description": "The description of the service account", - "examples": [ - "This is a service account for the external Example system" - ] - }, - "iap_service-accounts-schema_clientId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "iap_service-accounts-schema_clientSecret": { - "type": "string", - "description": "Uuid representation of client secret", - "examples": ["d4c673d6-17f8-4e76-8034-a87820f96618"] - }, - "iap_service-accounts-schema_modifiedByDereferenced": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "username": { - "type": "string", - "examples": ["username@itential"] - } - } - }, - "iap_service-accounts-schema_timestamp": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "formbuilder_formDocument": { - "title": "form document", - "description": "A form document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - "name": { - "type": "string", - "examples": ["Form 123"] - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time" - }, - "created_by": {}, - "last_updated": { - "type": "string", - "format": "date-time" - }, - "last_updated_by": {}, - "elements": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["service_model"] - }, - "id": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["/ncs:services/test_devices:service_name"] - } - }, - "required": ["name"] - } - }, - "required": ["type", "id"] - }, - "examples": [ - [ - { - "type": "method", - "id": { - "name": "method_name_1" - } - } - ] - ] - }, - "children": { - "type": "array", - "items": { - "type": "object", - "required": ["properties", "id", "type"], - "properties": { - "id": { - "type": "string", - "oneOf": [ - { - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - { - "pattern": "cont-." - } - ] - }, - "element": { - "type": "string", - "examples": [ - "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}" - ] - }, - "type": { - "type": "string", - "examples": ["container"] - }, - "name": { - "type": "string", - "examples": ["vlan_id_123"] - }, - "display_name": { - "type": "string", - "examples": ["vlan"] - }, - "source_type": { - "type": "string", - "enum": ["service_model", "custom", "method"] - }, - "source": { - "type": "string", - "examples": ["/ncs:services/abc_devices:ios.device"] - }, - "key": { - "type": "string", - "examples": [ - "service.vlanid", - "key_545385c3-fc66-491b-bf6f-abc2214366dc" - ] - }, - "properties": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["leafref"] - }, - "path": { - "type": "string", - "examples": ["/ncs:devices/ncs:device/ncs:name"] - }, - "min": { - "anyOf": [ - { - "type": "string", - "examples": ["1"] - }, - { - "type": "integer", - "examples": [1] - }, - { - "type": "null" - } - ] - }, - "max": { - "anyOf": [ - { - "type": "string", - "examples": ["4"] - }, - { - "type": "integer", - "examples": [1] - }, - { - "type": "null" - } - ] - }, - "minLength": { - "anyOf": [ - { - "type": "string", - "examples": ["1"] - }, - { - "type": "integer", - "examples": [1] - }, - { - "type": "null" - } - ] - }, - "maxLength": { - "anyOf": [ - { - "type": "string", - "examples": ["4"] - }, - { - "type": "integer", - "examples": [1] - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "null" - } - ] - }, - "direction": { - "type": "string", - "examples": ["vertical"] - }, - "required": { - "type": "boolean" - }, - "enforce": { - "type": "boolean" - }, - "hidden": { - "type": "boolean" - } - } - } - }, - "examples": [ - { - "type": "field", - "name": "ipaddress", - "properties": { - "type": "string", - "prefix": "" - }, - "description": "IP address", - "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}", - "source_type": "method", - "source": "method_name_1", - "id": "a40044c2-f378-4b2b-a81a-41d78979e583", - "yangkey": "", - "key": "method_name_1.ipAddress" - } - ] - } - } - }, - "required": ["name", "children", "elements"] - }, - "formbuilder_formDocument_formName": { - "type": "string", - "examples": ["Form 123"] - }, - "formbuilder_formDocument_ObjectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formbuilder_formDocument_uuidv4": { - "type": "string", - "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - }, - "formbuilder_formDocument_groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "formbuilder_formDocument_elements": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["service_model"] - }, - "id": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["/ncs:services/test_devices:service_name"] - } - }, - "required": ["name"] - } - }, - "required": ["type", "id"] - }, - "examples": [ - [ - { - "type": "method", - "id": { - "name": "method_name_1" - } - } - ] - ] - }, - "search_searchResults": { - "title": "search results", - "description": "The results of a search", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "examples": [ - "Forms", - "The Title of the Application the result came from." - ] - }, - "type": { - "type": "string", - "examples": [ - "forms", - "The name of the Collection the result came from" - ] - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": [ - "912fd926-5391-48ff-b265-394d00640f4f", - "The id of the result." - ] - }, - "name": { - "type": "string", - "examples": ["testForm", "Name of the result."] - }, - "description": { - "type": "string", - "examples": [ - "Hi I describe the result", - "Description for the result is optional." - ] - }, - "url": { - "type": "string", - "examples": [ - "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f", - "The shortened url to access the result from." - ] - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": [ - "5c8fa4a8d8e04500b1b2f28f", - "The id of the tag." - ] - }, - "description": { - "type": "string", - "examples": [ - "Hi I describe the tag", - "Description for the tag is optional." - ] - }, - "name": { - "type": "string", - "examples": ["testTag", "Name of the tag."] - } - } - } - } - } - } - }, - "count": { - "type": "integer" - } - } - } - } - } - }, - "configuration_manager_common_mongoObjectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "configuration_manager_common_timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "configuration_manager_common_standardName": { - "type": "string", - "examples": ["my standard name"], - "minLength": 1 - }, - "configuration_manager_common_standardDescription": { - "type": "string", - "examples": ["my standard description"], - "minLength": 1 - }, - "configuration_manager_common_multiElementString": { - "type": "string", - "examples": ["device1, device2, device3, device4"], - "minLength": 1 - }, - "configuration_manager_deviceData_deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "configuration_manager_deviceData_deviceDetails": { - "title": "deviceDetails", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["xr9kv01-aws"] - }, - "authgroup": { - "type": "string", - "examples": ["xr9kv-aws"] - }, - "ipaddress": { - "type": "string", - "examples": ["10.1.6.100"] - }, - "address": { - "type": "string", - "examples": ["10.1.6.100"] - }, - "port": { - "type": "string", - "examples": ["22"] - }, - "device-type": { - "type": "string", - "examples": ["cli"] - }, - "ostype": { - "type": "string", - "examples": ["cisco-ios-xr"] - }, - "ned": { - "type": "string", - "examples": ["cisco-ios-xr"] - }, - "admin": { - "type": "boolean" - }, - "host": { - "type": "string", - "examples": ["nso46"] - }, - "actions": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "addDevice", - "addDeviceGroup", - "addDeviceToGroup", - "addToAuthGroup", - "applyTemplate", - "applyTemplates", - "applyVariableTemplate", - "checkSync", - "checkSyncDevices", - "isAlive", - "deleteDevice", - "deleteDeviceGroup", - "dryRunVariableTemplate", - "getAuthGroups", - "getConfig", - "getDevice", - "getDeviceGroups", - "getDeviceGroupsForDevices", - "getDevices", - "getDevicesFiltered", - "getNEDs", - "getOutOfSyncConfig", - "getTemplates", - "liveStatus", - "passThru", - "pingDevice", - "removeDeviceFromGroup", - "restoreDevice", - "runAction", - "runCommand", - "setConfig", - "syncFrom", - "syncFromDevices", - "syncTo", - "syncToDevices", - "turnUpDevice", - "verifyConfig" - ] - }, - "uniqueItems": true - }, - "origins": { - "type": "array", - "items": { - "type": "string", - "examples": ["nso46"] - } - } - }, - "required": [ - "name", - "device-type", - "ipaddress", - "port", - "ostype", - "host", - "actions", - "origin" - ] - }, - "configuration_manager_deviceData_deviceConfigurationFormat": { - "title": "format", - "type": "string", - "enum": ["native", "xml", "json"], - "examples": ["native"] - }, - "configuration_manager_deviceData_deviceConfiguration": { - "title": "config", - "type": "object", - "properties": { - "device": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "config": { - "type": "string", - "examples": ["hostname ios0\nno service password-encryption\n..."] - } - } - }, - "configuration_manager_deviceData_deviceConfigurationString": { - "type": "string", - "examples": ["hostname ios0\nno service password-encryption\n..."] - }, - "configuration_manager_deviceData_backupDescription": { - "type": "string", - "examples": ["description of backup"] - }, - "configuration_manager_deviceData_backupNotes": { - "type": "string", - "examples": ["notes about backup"] - }, - "configuration_manager_deviceData_backup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "provider": { - "type": "string" - }, - "type": { - "title": "format", - "type": "string", - "enum": ["native", "xml", "json"], - "examples": ["native"] - }, - "date": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "rawConfig": { - "type": "string", - "examples": ["hostname ios0\nno service password-encryption\n..."] - }, - "description": { - "type": "string", - "examples": ["description of backup"] - }, - "notes": { - "type": "string", - "examples": ["notes about backup"] - }, - "gbac": { - "type": "object", - "description": "Sets of group Ids that are allowd to access this automation.", - "properties": { - "write": { - "type": "array", - "description": "Group ids that have write access to the automation document.", - "items": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - }, - "read": { - "type": "array", - "description": "Group ids that have read access to the automation document.", - "items": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - }, - "required": ["write", "read"] - } - } - }, - "configuration_manager_deviceGroupDocument": { - "$schema": "http://json-schema.org/draft-07/schema#", - "description": "A group of devices that are referenced by name only", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string", - "examples": ["my standard name"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["my standard description"], - "minLength": 1 - }, - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - } - }, - "additionalProperties": true - }, - "configuration_manager_deviceGroupDocument_groupDetails": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["my standard name"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["my standard description"], - "minLength": 1 - }, - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - } - }, - "required": ["name"], - "additionalProperties": false - }, - "configuration_manager_deviceGroupDocument_updateGroupDetails": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["my standard name"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["my standard description"], - "minLength": 1 - }, - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - } - }, - "additionalProperties": false - }, - "configuration_manager_deviceGroupDocument_createGroupResponseWithName": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string" - }, - "message": { - "type": "string" - }, - "status": { - "type": "string" - } - }, - "required": ["id", "name", "message", "status"] - }, - "configuration_manager_deviceGroupDocument_updateGroupsResponse": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "modified": { - "type": "number" - } - }, - "required": ["status", "modified"] - }, - "configuration_manager_deviceGroupDocument_deleteGroupResponse": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "deleted": { - "type": "number" - } - }, - "required": ["status", "deleted"] - }, - "configuration_manager_goldenConfigData_goldenConfigNodePath": { - "title": "goldenConfigNodePath", - "type": "string", - "examples": ["base", "base/US East", "base/US East/Atlanta"] - }, - "configuration_manager_goldenConfigData_goldenConfigTreeVersionName": { - "title": "goldenConfigTreeVersionName", - "type": "string", - "examples": ["initial", "v2", "v3", "draft-v4"] - }, - "configuration_manager_goldenConfigData_goldenConfigNode": { - "title": "goldenConfigNode", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["base", "us-east", "edge"] - }, - "attributes": { - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "children": { - "type": "array", - "items": { - "title": "goldenConfigNode", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["base", "us-east", "edge"] - }, - "attributes": { - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "children": { - "type": "array", - "items": {} - } - }, - "required": ["name", "attributes", "children"] - } - } - }, - "required": ["name", "attributes", "children"] - }, - "configuration_manager_goldenConfigData_goldenConfigTreeVersion": { - "title": "goldenConfigTreeVersion", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string", - "examples": [ - "Cisco Edge - Day 0", - "Cisco Edge - Day 1", - "Cisco Core - Day 0", - "Cisco Core - Day 1" - ] - }, - "deviceType": { - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "version": { - "type": "string", - "examples": ["initial", "v2", "v3", "draft v4"] - }, - "root": { - "title": "goldenConfigNode", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["base", "us-east", "edge"] - }, - "attributes": { - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "children": { - "type": "array", - "items": {} - } - }, - "required": ["name", "attributes", "children"] - }, - "variables": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["variable name"] - }, - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["variable value"] - } - } - } - }, - "created": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "lastUpdated": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "lastUpdatedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary": { - "title": "goldenConfigTreeVersion", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string", - "examples": [ - "Cisco Edge - Day 0", - "Cisco Edge - Day 1", - "Cisco Core - Day 0", - "Cisco Core - Day 1" - ] - }, - "deviceType": { - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "versions": { - "type": "array", - "items": { - "type": "string", - "examples": ["initial", "v2", "v3", "draft v4"] - } - }, - "created": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "lastUpdated": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigSpecWord": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigSpecLineId": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "configuration_manager_goldenConfigData_goldenConfigSpecLine": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": ["required", "disallowed", "ignored", "optional"] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": ["required", "disallowed", "ignored", "optional"] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": {} - } - } - } - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigSpec": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "deviceType": { - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "lines": { - "type": "array", - "items": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": ["required", "disallowed", "ignored", "optional"] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": {} - } - } - } - }, - "created": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "lastUpdated": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "lastUpdatedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigJSONSpec": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "deviceType": { - "type": "string", - "examples": ["json"] - }, - "data": { - "type": "object", - "properties": {} - }, - "created": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "lastUpdated": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "lastUpdatedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigVariables": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["variable name"] - }, - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["variable value"] - } - } - } - }, - { - "type": "object", - "properties": {}, - "additionalProperties": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["string value", "^regular.*expression$"] - } - } - }, - { - "type": "string", - "examples": ["string value"] - } - ] - } - } - ] - }, - "configuration_manager_goldenConfigData_reportGradingOptions": { - "type": "object", - "properties": { - "weights": { - "type": "object", - "properties": { - "error": { - "type": "number" - }, - "warning": { - "type": "number" - }, - "info": { - "type": "number" - } - } - }, - "benchmarks": { - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "number" - } - } - } - }, - "configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions": { - "type": "object", - "properties": { - "weights": { - "type": "object", - "properties": { - "error": { - "type": "number" - }, - "warning": { - "type": "number" - }, - "info": { - "type": "number" - } - } - }, - "benchmarks": { - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "number" - } - }, - "limit": { - "type": "integer", - "minimum": 1 - } - } - }, - "configuration_manager_goldenConfigData_complianceSummary": { - "title": "complianceSummary", - "type": "object", - "properties": { - "errors": { - "type": "integer", - "minimum": 0 - }, - "warnings": { - "type": "integer", - "minimum": 0 - }, - "passes": { - "type": "integer", - "minimum": 0 - }, - "infos": { - "type": "integer", - "minimum": 0 - }, - "deviceWithErrors": { - "type": "integer", - "minimum": 0 - }, - "deviceWithWarnings": { - "type": "integer", - "minimum": 0 - }, - "deviceWithInfos": { - "type": "integer", - "minimum": 0 - }, - "fullyCompliantDevices": { - "type": "integer", - "minimum": 0 - }, - "numDevices": { - "type": "integer", - "minimum": 0 - } - } - }, - "configuration_manager_goldenConfigData_complianceReport": { - "title": "complianceReport", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "batchId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "treeId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "version": { - "title": "goldenConfigTreeVersionName", - "type": "string", - "examples": ["initial", "v2", "v3", "draft-v4"] - }, - "nodePath": { - "title": "goldenConfigNodePath", - "type": "string", - "examples": ["base", "base/US East", "base/US East/Atlanta"] - }, - "deviceType": { - "type": "string", - "examples": ["cisco-ios", "cisco-ios-xr", "junos"] - }, - "specId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "inheritedSpecIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - }, - "deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "variables": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["variable name"] - }, - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["variable value"] - } - } - } - }, - "timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "totals": { - "type": "object", - "properties": { - "errors": { - "type": "integer", - "minimum": 0 - }, - "warnings": { - "type": "integer", - "minimum": 0 - }, - "infos": { - "type": "integer", - "minimum": 0 - }, - "passes": { - "type": "integer", - "minimum": 0 - } - } - }, - "issues": { - "type": "array", - "items": { - "title": "complianceIssue", - "type": "object", - "properties": { - "severity": { - "enum": ["error", "warning", "info"] - }, - "type": { - "enum": ["required", "disallowed"] - }, - "message": { - "type": "string", - "examples": ["Required config not found"] - }, - "specLineId": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "path": { - "type": "array", - "items": { - "type": "string", - "examples": ["interface GigE1"] - } - }, - "spec": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": ["required", "disallowed", "ignored", "optional"] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": {} - } - } - }, - "configWords": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "literal" - }, - "value": { - "type": "string", - "examples": ["word"] - } - } - } - }, - "candidates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "literal" - }, - "value": { - "type": "string", - "examples": ["word"] - } - } - } - } - } - } - }, - "score": { - "type": "number" - } - } - }, - "configuration_manager_goldenConfigData_complianceReportBrief": { - "title": "complianceReportBrief", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "batchId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "treeId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "version": { - "type": "string", - "examples": ["initial", "v2", "v3", "draft v4"] - }, - "nodePath": { - "title": "goldenConfigNodePath", - "type": "string", - "examples": ["base", "base/US East", "base/US East/Atlanta"] - }, - "deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "totals": { - "type": "object", - "properties": { - "errors": { - "type": "integer", - "minimum": 0 - }, - "warnings": { - "type": "integer", - "minimum": 0 - }, - "infos": { - "type": "integer", - "minimum": 0 - }, - "passes": { - "type": "integer", - "minimum": 0 - } - } - } - } - }, - "configuration_manager_goldenConfigData_complianceReportBriefGraded": { - "title": "complianceReportBriefGraded", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "error": { - "type": "integer", - "minimum": 0 - }, - "warning": { - "type": "integer", - "minimum": 0 - }, - "info": { - "type": "integer", - "minimum": 0 - }, - "pass": { - "type": "integer", - "minimum": 0 - }, - "score": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "grade": { - "type": "string", - "examples": ["pass", "review", "fail"] - } - } - }, - "configuration_manager_goldenConfigData_complianceReportGraded": { - "title": "complianceReportGraded", - "allOf": [ - { - "title": "complianceReport", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "batchId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "treeId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "version": { - "title": "goldenConfigTreeVersionName", - "type": "string", - "examples": ["initial", "v2", "v3", "draft-v4"] - }, - "nodePath": { - "title": "goldenConfigNodePath", - "type": "string", - "examples": ["base", "base/US East", "base/US East/Atlanta"] - }, - "deviceType": { - "type": "string", - "examples": ["cisco-ios", "cisco-ios-xr", "junos"] - }, - "specId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "inheritedSpecIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - }, - "deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "variables": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["variable name"] - }, - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["variable value"] - } - } - } - }, - "timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "totals": { - "type": "object", - "properties": { - "errors": { - "type": "integer", - "minimum": 0 - }, - "warnings": { - "type": "integer", - "minimum": 0 - }, - "infos": { - "type": "integer", - "minimum": 0 - }, - "passes": { - "type": "integer", - "minimum": 0 - } - } - }, - "issues": { - "type": "array", - "items": { - "title": "complianceIssue", - "type": "object", - "properties": { - "severity": { - "enum": ["error", "warning", "info"] - }, - "type": { - "enum": ["required", "disallowed"] - }, - "message": { - "type": "string", - "examples": ["Required config not found"] - }, - "specLineId": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "path": { - "type": "array", - "items": { - "type": "string", - "examples": ["interface GigE1"] - } - }, - "spec": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": [ - "required", - "disallowed", - "ignored", - "optional" - ] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": {} - } - } - }, - "configWords": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "literal" - }, - "value": { - "type": "string", - "examples": ["word"] - } - } - } - }, - "candidates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "literal" - }, - "value": { - "type": "string", - "examples": ["word"] - } - } - } - } - } - } - }, - "score": { - "type": "number" - } - } - }, - { - "type": "object", - "properties": { - "score": { - "type": "number" - }, - "grade": { - "type": "string", - "examples": ["pass", "fail", "review"] - } - } - } - ] - }, - "automation-studio_automation": { - "title": "workflow document", - "description": "Third generation workflow document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "namespace": { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - }, - "name": { - "type": "string", - "examples": [ - "Port Turn Up IOS", - "Push Config to Device", - "Command Template Runner" - ] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "string", - "examples": ["Port Turn Up IOS", "Push Config to Device"] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "integer", - "title": "Pre automation time of automation", - "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", - "examples": [5000, 250000] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "workflow_end": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "sla": { - "type": "integer", - "title": "Task SLA", - "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", - "examples": ["3600000"] - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": {}, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": {}, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "canvasVersion": { - "type": "number", - "const": 3 - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - } - }, - "additionalProperties": false, - "required": [ - "name", - "type", - "tasks", - "transitions", - "groups", - "canvasVersion" - ] - }, - "automation-studio_automationUpdate": { - "title": "workflow document", - "description": "Third generation workflow document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "namespace": { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - }, - "name": { - "type": "string", - "examples": [ - "Port Turn Up IOS", - "Push Config to Device", - "Command Template Runner" - ] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "string", - "examples": ["Port Turn Up IOS", "Push Config to Device"] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "integer", - "title": "Pre automation time of automation", - "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", - "examples": [5000, 250000] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "workflow_end": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "sla": { - "type": "integer", - "title": "Task SLA", - "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", - "examples": ["3600000"] - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": {}, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": {}, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "canvasVersion": { - "type": "number", - "const": 3 - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - } - }, - "additionalProperties": false, - "required": [ - "name", - "type", - "tasks", - "transitions", - "groups", - "canvasVersion" - ] - }, - "automation-studio_componentGroup": { - "title": "Component Group Document", - "description": "An entity representing a component group.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the component group" - }, - "name": { - "type": "string", - "examples": ["Infoblox Workflows"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["Infoblox Workflows"] - }, - "gbacRead": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "CAcFAfEa9aCe7ba08d482B3F", - "F880C8dEBAf70BfB85ec7eCc", - "5AC59E1De2Ce2203cFeb3E22" - ] - } - }, - "gbacWrite": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "CAcFAfEa9aCe7ba08d482B3F", - "F880C8dEBAf70BfB85ec7eCc", - "5AC59E1De2Ce2203cFeb3E22" - ] - } - }, - "members": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "properties": { - "path": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - } - }, - "type": { - "enum": ["folder"] - } - } - }, - { - "properties": { - "path": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - }, - "type": { - "enum": ["component"] - }, - "sourceCollection": { - "type": "string", - "examples": ["workflows", "json-forms", "transformations"] - }, - "ref": { - "type": "string", - "examples": ["7192B8CcD680858dA81EADCa"] - } - } - } - ] - } - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "meta": { - "type": "object" - } - }, - "required": ["name", "gbacRead", "members"], - "additionalProperties": false - }, - "automation-studio_componentGroupImport": { - "title": "Component Group Import Data", - "description": "Data to import as a new component group document.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the component group" - }, - "name": { - "type": "string", - "examples": ["Assign Next IP - Infoblox", "Get Next IP - Infoblox"], - "minLength": 1 - }, - "gbacRead": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "CAcFAfEa9aCe7ba08d482B3F", - "F880C8dEBAf70BfB85ec7eCc", - "5AC59E1De2Ce2203cFeb3E22" - ] - } - }, - "members": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "properties": { - "path": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - } - }, - "type": { - "enum": ["folder"] - } - } - }, - { - "properties": { - "path": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - }, - "type": { - "enum": ["component"] - }, - "sourceCollection": { - "type": "string", - "examples": ["workflows", "json-forms", "transformations"] - }, - "ref": { - "type": "string", - "examples": ["7192B8CcD680858dA81EADCa"] - } - } - } - ] - } - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "meta": { - "type": "object" - } - }, - "required": ["name", "gbacRead", "members"], - "additionalProperties": false - }, - "automation-studio_componentGroupUpdate": { - "title": "Component Group Update", - "description": "An entity representing an update to an existing template document.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the component group" - }, - "name": { - "type": "string", - "examples": ["Assign Next IP - Infoblox", "Get Next IP - Infoblox"], - "minLength": 1 - }, - "gbacRead": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "CAcFAfEa9aCe7ba08d482B3F", - "F880C8dEBAf70BfB85ec7eCc", - "5AC59E1De2Ce2203cFeb3E22" - ] - } - }, - "members": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "properties": { - "path": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - } - }, - "type": { - "enum": ["folder"] - } - } - }, - { - "properties": { - "path": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - }, - "type": { - "enum": ["component"] - }, - "sourceCollection": { - "type": "string", - "examples": ["workflows", "json-forms", "transformations"] - }, - "ref": { - "type": "string", - "examples": ["7192B8CcD680858dA81EADCa"] - } - } - } - ] - } - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "meta": { - "type": "object" - } - }, - "required": ["name", "gbacRead", "members"], - "additionalProperties": false - }, - "automation-studio_project-thumbnails-update-data": { - "title": "Project Thumbnail Update Values", - "description": "Project Thumbnail Update Values", - "type": "object", - "required": ["imageData"], - "properties": { - "imageData": { - "description": "Binary image data encoded as a base64 string", - "type": "string" - }, - "backgroundColor": { - "description": "Thumbnail background color", - "type": "string", - "default": "#FFFFFF" - } - } - }, - "automation-studio_projects-common_components": { - "title": "Project components", - "description": "A list of member components in the project", - "type": "array", - "items": { - "title": "Project component", - "description": "An IAP component which resides within a project", - "type": "object", - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string", - "examples": [ - "1Ac4B2268489019745B5baa4", - "2D772A00dd2Ccedf3bd313bd", - "866a9B98DdD58Ff0e14ebB16" - ] - }, - "folder": { - "title": "Project component folder", - "description": "", - "type": "string", - "pattern": "^/" - } - } - } - }, - "automation-studio_projects-create-data": { - "title": "Project Create Data", - "description": "POST body properties required to create a project", - "type": "object", - "additionalProperties": true, - "required": ["name"], - "properties": { - "name": { - "description": "Project name", - "type": "string", - "examples": [ - "Firewall Service Provisioning", - "Arista EOS Utilities", - "Github" - ] - }, - "description": { - "title": "Project description", - "description": "A free-form block of text for describing project intent and function", - "type": "string", - "examples": [ - "This project is used at Acme Corp as the foundation of some major parts of our business process.", - "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" - ] - }, - "components": { - "title": "Project components", - "description": "A list of member components in the project", - "type": "array", - "items": { - "title": "Project component", - "description": "An IAP component which resides within a project", - "type": "object", - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string", - "examples": [ - "1Ac4B2268489019745B5baa4", - "2D772A00dd2Ccedf3bd313bd", - "866a9B98DdD58Ff0e14ebB16" - ] - }, - "folder": { - "title": "Project component folder", - "description": "", - "type": "string", - "pattern": "^/" - } - } - } - } - } - }, - "automation-studio_projects-export-v1": { - "title": "Project Export Document", - "description": "An exported project document", - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "iid", - "name", - "description", - "thumbnail", - "backgroundColor", - "components", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "name": { - "description": "Project name", - "type": "string", - "examples": [ - "Firewall Service Provisioning", - "Arista EOS Utilities", - "Github" - ] - }, - "description": { - "title": "Project description", - "description": "A free-form block of text for describing project intent and function", - "type": "string", - "examples": [ - "This project is used at Acme Corp as the foundation of some major parts of our business process.", - "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" - ] - }, - "thumbnail": { - "description": "Base64 string encoding binary image data for project thumbnail", - "type": "string" - }, - "backgroundColor": { - "description": "Thumbnail background color", - "type": "string", - "default": "#FFFFFF" - }, - "components": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": ["iid", "type", "reference", "folder", "document"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string", - "examples": [ - "1Ac4B2268489019745B5baa4", - "2D772A00dd2Ccedf3bd313bd", - "866a9B98DdD58Ff0e14ebB16" - ] - }, - "folder": { - "title": "Project component folder", - "description": "", - "type": "string", - "pattern": "^/" - }, - "document": { - "title": "Component export", - "description": "Full component document", - "type": "object" - } - } - } - }, - "referencedComponentHashes": { - "oneOf": [ - { - "type": "array" - }, - { - "type": "null" - } - ], - "items": { - "type": "object", - "additionalProperties": false, - "required": ["type", "reference", "hash", "name"], - "properties": { - "type": { - "type": "string" - }, - "reference": { - "type": "string" - }, - "name": { - "type": "string", - "description": "The last known name of the exported document" - }, - "hash": { - "type": "string" - }, - "query": { - "type": "object" - } - } - } - }, - "referencedComponents": { - "oneOf": [ - { - "type": "array" - }, - { - "type": "null" - } - ], - "items": { - "type": "object", - "additionalProperties": false, - "required": ["type", "reference", "document"], - "properties": { - "type": { - "type": "string" - }, - "reference": { - "type": "string" - }, - "document": { - "title": "Referenced component export", - "description": "Full referenced component document", - "type": "object" - } - } - } - }, - "folders": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "required": ["name", "nodeType", "children"], - "properties": { - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "name": { - "description": "Folder name", - "type": "string", - "examples": ["folder-1", "folder-2"] - }, - "children": { - "type": "array", - "items": { - "oneOf": [ - {}, - { - "type": "object", - "required": ["iid", "nodeType"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string" - } - } - } - ] - } - } - } - }, - { - "type": "object", - "required": ["iid", "nodeType"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string" - } - } - } - ] - } - }, - "created": { - "title": "ISO Date String", - "description": "ISO Date String", - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "createdBy": {}, - "lastUpdated": { - "title": "ISO Date String", - "description": "ISO Date String", - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "lastUpdatedBy": {}, - "versionHistory": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "versionNumber", - "commitMessage", - "author", - "branchName" - ], - "properties": { - "versionNumber": { - "type": "integer", - "examples": [1] - }, - "commitMessage": { - "type": "string" - }, - "author": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - } - } - } - } - } - }, - "automation-studio_projects-http-id": { - "title": "Projects HTTP ID", - "description": "Project identifier as understood by the HTTP API", - "oneOf": [ - { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - } - ] - }, - "automation-studio_projects-http": { - "title": "Project HTTP Data", - "description": "Project data as it is sent back from get and search endpoints", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "_id": { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "name": { - "description": "Project name", - "type": "string", - "examples": [ - "Firewall Service Provisioning", - "Arista EOS Utilities", - "Github" - ] - }, - "description": { - "title": "Project description", - "description": "A free-form block of text for describing project intent and function", - "type": "string", - "examples": [ - "This project is used at Acme Corp as the foundation of some major parts of our business process.", - "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" - ] - }, - "members": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": ["type", "reference", "role"], - "properties": { - "type": { - "type": "string", - "enum": ["account", "group"] - }, - "reference": { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "role": { - "type": "string", - "enum": ["owner", "editor", "operator", "viewer"] - }, - "missing": { - "type": "boolean" - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - } - } - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - }, - "componentIidIndex": { - "title": "Component IID Index", - "description": "Read-only property providing incrementing integer ID values for child components within a project", - "type": "integer", - "minimum": 0 - }, - "components": { - "title": "Project components", - "description": "A list of member components in the project", - "type": "array", - "items": { - "title": "Project component", - "description": "An IAP component which resides within a project", - "type": "object", - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string", - "examples": [ - "1Ac4B2268489019745B5baa4", - "2D772A00dd2Ccedf3bd313bd", - "866a9B98DdD58Ff0e14ebB16" - ] - }, - "folder": { - "title": "Project component folder", - "description": "", - "type": "string", - "pattern": "^/" - } - } - } - }, - "folders": { - "title": "Project folders", - "description": "A list of folders and their members", - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "required": ["name", "nodeType", "children"], - "properties": { - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "name": { - "description": "Folder name", - "type": "string", - "examples": ["folder-1", "folder-2"] - }, - "children": { - "type": "array", - "items": { - "oneOf": [ - {}, - { - "type": "object", - "required": ["iid", "nodeType"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string" - } - } - } - ] - } - } - } - }, - { - "type": "object", - "required": ["iid", "nodeType"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string" - } - } - } - ] - } - }, - "created": { - "title": "ISO Date String", - "description": "ISO Date String", - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "createdBy": {}, - "lastUpdated": { - "title": "ISO Date String", - "description": "ISO Date String", - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "lastUpdatedBy": {}, - "versionHistory": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "versionNumber", - "commitMessage", - "author", - "branchName" - ], - "properties": { - "versionNumber": { - "type": "integer", - "examples": [1] - }, - "commitMessage": { - "type": "string" - }, - "author": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - } - } - } - }, - "gitConfiguration": { - "type": "object", - "additionalProperties": false, - "required": [ - "connectionType", - "repositoryPath", - "branchName", - "projectPath" - ], - "properties": { - "connectionType": { - "type": "string", - "enum": ["GitHub", "GitLab"] - }, - "repositoryPath": { - "type": "string", - "examples": ["Itential Open Source"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - }, - "projectPath": { - "type": "string", - "examples": ["Projects"] - } - } - } - } - }, - "automation-studio_projects-search-parameters": { - "title": "Project Search Parameters", - "description": "Parameters used to filter and paginate Project documents in the Project search API", - "type": "object", - "additionalProperties": true, - "properties": { - "equals": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "iid": { - "type": "number" - }, - "name": { - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "lastUpdatedBy": { - "type": "string" - } - } - }, - "in": { - "type": "object", - "properties": { - "_id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - }, - "iid": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - }, - "name": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - }, - "createdBy": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - } - }, - "starts-with": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "contains": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "name,description": { - "type": "string" - }, - "description,name": { - "type": "string" - } - } - }, - "sort": { - "type": "string", - "enum": [ - "_id", - "iid", - "name", - "created", - "lastUpdated", - "createdBy", - "lastUpdatedBy" - ] - }, - "order": { - "type": "string", - "enum": ["asc", "desc"] - }, - "skip": { - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "limit": { - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] - } - } - }, - "automation-studio_projects-update-data": { - "title": "Project Update Data", - "description": "PATCH body properties used to update a project", - "type": "object", - "additionalProperties": true, - "properties": { - "name": { - "description": "Project name", - "type": "string", - "examples": [ - "Firewall Service Provisioning", - "Arista EOS Utilities", - "Github" - ] - }, - "description": { - "title": "Project description", - "description": "A free-form block of text for describing project intent and function", - "type": "string", - "examples": [ - "This project is used at Acme Corp as the foundation of some major parts of our business process.", - "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" - ] - }, - "thumbnailBackgroundColor": { - "description": "Thumbnail background color", - "type": "string", - "default": "#FFFFFF" - }, - "members": { - "type": "array", - "items": { - "type": "object", - "required": ["type", "reference", "role"], - "additionalProperties": false, - "properties": { - "type": { - "type": "string", - "enum": ["account", "group"] - }, - "reference": { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "role": { - "type": "string", - "enum": ["owner", "editor", "operator", "viewer"] - } - } - } - }, - "version": { - "type": "object", - "additionalProperties": false, - "required": [ - "versionNumber", - "commitMessage", - "author", - "branchName" - ], - "properties": { - "versionNumber": { - "type": "integer", - "examples": [1] - }, - "commitMessage": { - "type": "string" - }, - "author": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - } - } - }, - "gitConfiguration": { - "type": "object", - "additionalProperties": false, - "required": [ - "connectionType", - "repositoryPath", - "branchName", - "projectPath" - ], - "properties": { - "connectionType": { - "type": "string", - "enum": ["GitHub", "GitLab"] - }, - "repositoryPath": { - "type": "string", - "examples": ["Itential Open Source"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - }, - "projectPath": { - "type": "string", - "examples": ["Projects"] - } - } - } - } - }, - "automation-studio_resource-ref-http": { - "title": "ResourceRef HTTP Data", - "description": "The resourceRef objects that are returned from getReferences", - "type": "object", - "additionalProperties": false, - "required": [ - "resourceType", - "resourcePointer", - "resourceId", - "parents" - ], - "properties": { - "resourceType": { - "type": "string" - }, - "resourcePointer": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "root": { - "type": "boolean" - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "resourceType", - "resourcePointer", - "resourceId", - "parentPointer" - ], - "properties": { - "resourceType": { - "type": "string" - }, - "resourcePointer": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "root": { - "type": "boolean" - }, - "parentPointer": { - "type": "string" - } - } - } - }, - "resource": { - "type": "object", - "description": "When using 'includeResources', this property will contain the full resource object" - } - } - }, - "automation-studio_taskDetails": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "The Root Schema", - "required": ["location", "name", "app", "variables"], - "properties": { - "location": { - "type": "string", - "enum": ["Application", "Adapter", "Broker"] - }, - "name": { - "type": "string", - "examples": ["query"] - }, - "app": { - "type": "string", - "examples": ["WorkFlowEngine"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "string", - "number", - "array", - "object", - "enum", - "boolean", - "*" - ] - }, - "description": { - "type": "string", - "examples": ["Example description"] - }, - "schema": { - "type": "object" - } - } - } - }, - "outgoing": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "string", - "number", - "array", - "object", - "enum", - "boolean", - "*" - ] - }, - "description": { - "type": "string", - "examples": ["Example description"] - }, - "schema": { - "type": "object" - } - } - } - } - } - } - } - }, - "automation-studio_template": { - "title": "Template Document", - "description": "An entity representing a data template.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the automation" - }, - "namespace": { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - }, - "name": { - "type": "string", - "examples": ["arista_eos_show_clock"], - "minLength": 1, - "pattern": "^(?!\\s)[\\w\\s]+(? Record\n" - ], - "minLength": 1 - }, - "data": { - "type": "string", - "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], - "minLength": 1 - }, - "type": { - "type": "string", - "examples": ["textfsm", "jinja2"], - "enum": ["textfsm", "jinja2"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the automation" - }, - "created": { - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "lastUpdatedBy": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the automation" - }, - "lastUpdated": { - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "description": "A user-defined object to help group documents.", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the automation" - }, - "name": { - "type": "string", - "description": "user-given, unique string to ID tag" - } - } - } - } - }, - "required": [ - "name", - "group", - "command", - "description", - "template", - "data", - "type" - ], - "additionalProperties": false - }, - "automation-studio_templateImport": { - "title": "Template Import Data", - "description": "Data to import as a new template document.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "Unique identifier of the automation" - }, - "name": { - "type": "string", - "examples": ["arista_eos_show_clock"], - "minLength": 1 - }, - "projectId": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$" - } - ] - }, - "group": { - "type": "string", - "examples": ["Arista"], - "minLength": 1 - }, - "device": { - "type": "string", - "examples": ["Arista EOS"], - "minLength": 1 - }, - "command": { - "type": "string", - "examples": ["show clock"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["Arista Show Clock Info"], - "minLength": 1 - }, - "template": { - "type": "string", - "examples": [ - "Value TIME (d+:d+:d+)\nValue TIMEZONE (S+)\nValue DAYWEEK (w+)\nValue MONTH (w+)\nValue DAY (d+)\nValue YEAR (d+)\n\nStart\n ^${DAYWEEK}s+${MONTH}s+${DAY}s+${TIME}s+${YEAR}\n ^[t|T]imezone(:|sis)s+${TIMEZONE} -> Record\n" - ], - "minLength": 1 - }, - "data": { - "type": "string", - "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], - "minLength": 1 - }, - "text": { - "type": "string", - "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], - "minLength": 1 - }, - "type": { - "type": "string", - "examples": ["textfsm", "jinja2"], - "enum": ["textfsm", "jinja2"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "Unique identifier of the automation" - }, - "created": { - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "lastModifiedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "Unique identifier of the automation" - }, - "lastUpdated": { - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "description": "A user-defined object to help group documents.", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "Unique identifier of the automation" - }, - "name": { - "type": "string", - "description": "user-given, unique string to ID tag" - } - } - } - } - }, - "oneOf": [ - { - "required": [ - "_id", - "name", - "group", - "command", - "description", - "template", - "data", - "type" - ] - }, - { - "required": [ - "_id", - "name", - "device", - "command", - "template", - "text", - "type" - ] - } - ], - "additionalProperties": false - }, - "automation-studio_templateUpdate": { - "title": "Template Update", - "description": "An entity representing an update to an existing template document.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["arista_eos_show_clock"], - "minLength": 1 - }, - "group": { - "type": "string", - "examples": ["Arista"], - "minLength": 1 - }, - "projectId": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$" - } - ] - }, - "command": { - "type": "string", - "examples": ["show clock"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["Arista Show Clock Info"], - "minLength": 1 - }, - "template": { - "type": "string", - "examples": [ - "Value TIME (d+:d+:d+)\nValue TIMEZONE (S+)\nValue DAYWEEK (w+)\nValue MONTH (w+)\nValue DAY (d+)\nValue YEAR (d+)\n\nStart\n ^${DAYWEEK}s+${MONTH}s+${DAY}s+${TIME}s+${YEAR}\n ^[t|T]imezone(:|sis)s+${TIMEZONE} -> Record\n" - ], - "minLength": 1 - }, - "data": { - "type": "string", - "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], - "minLength": 1 - }, - "type": { - "type": "string", - "examples": ["textfsm", "jinja2"], - "enum": ["textfsm", "jinja2"] - } - }, - "required": [ - "name", - "group", - "command", - "description", - "template", - "data", - "type" - ], - "additionalProperties": false - }, - "automation-studio_workflowDocument": { - "title": "workflow document", - "description": "Third generation workflow document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "namespace": { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - }, - "name": { - "type": "string", - "examples": [ - "Port Turn Up IOS", - "Push Config to Device", - "Command Template Runner" - ] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "string", - "examples": ["Port Turn Up IOS", "Push Config to Device"] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "integer", - "title": "Pre automation time of automation", - "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", - "examples": [5000, 250000] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "workflow_end": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "sla": { - "type": "integer", - "title": "Task SLA", - "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", - "examples": ["3600000"] - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": {}, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": {}, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "canvasVersion": { - "type": "number", - "const": 3 - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - } - }, - "additionalProperties": false, - "required": [ - "name", - "type", - "tasks", - "transitions", - "groups", - "canvasVersion" - ] - }, - "automation-studio_workflowDocumentAll": { - "title": "workflow document", - "description": "Accepts all generation workflow documents", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - "name": { - "type": "string", - "examples": [ - "Port Turn Up IOS", - "Push Config to Device", - "Command Template Runner" - ] - }, - "type": { - "type": "string", - "default": "automation" - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - } - ] - }, - "description": { - "oneOf": [ - { - "type": "string", - "examples": ["Port Turn Up IOS", "Push Config to Device"] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "number", - "examples": [5000, 250000] - }, - "sla": { - "type": "number", - "examples": [10] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - } - }, - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - } - ] - }, - "workflow_end": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - } - }, - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string" - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "additionalProperties": false - }, - "errorHandler": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - ] - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": { - "oneOf": [ - { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["username", "provenance"] - }, - { - "type": "null" - } - ] - }, - "createdVersion": { - "type": "string", - "examples": ["5.40.5-2021.1.72.0"] - }, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": { - "oneOf": [ - { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["username", "provenance"] - }, - { - "type": "null" - } - ] - }, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "required": ["_id", "name", "description"] - } - }, - "canvasVersion": { - "type": "number", - "enum": [1, 1.5, 2, 3] - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - }, - "inputSchema": { - "type": "object" - }, - "outputSchema": { - "type": "object" - }, - "outputData": { - "type": "object" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "migrationVersion": { - "type": "integer", - "minimum": 0 - } - }, - "additionalProperties": true, - "required": ["name", "type", "tasks", "transitions", "groups"] - }, - "tags_tagDocument_tagName": { - "type": "string", - "examples": ["My Tag"] - }, - "tags_tagDocument_tagId": { - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - }, - "tags_tagDocument_tagDescription": { - "type": "string", - "examples": ["Descriptions can be empty"] - }, - "tags_tagDocument_contentRefId": { - "type": "string", - "examples": ["The id of the content to be referenced"] - }, - "tags_tagDocument_contentRefType": { - "type": "string", - "examples": ["The id of the content to be referenced"] - }, - "tags_tagDocument_tagObject": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - }, - "description": { - "type": "string", - "examples": ["Descriptions can be empty"] - }, - "name": { - "type": "string", - "examples": ["My Tag"] - } - } - }, - "tags_tagDocument_referenceObject": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["new created reference id"] - }, - "tag_id": { - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - }, - "ref_id": { - "type": "string", - "examples": ["The id of the content to be referenced"] - }, - "type": { - "type": "string", - "examples": ["The id of the content to be referenced"] - } - } - }, - "workflow_engine_jobMetricsDocument": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Job metrics schema", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "workflow": { - "type": "object", - "title": "Automation the job was started on.", - "properties": { - "name": { - "type": "string", - "title": "Name of the automation the job was started on", - "examples": ["exampleAutomationName"] - }, - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "Automation objectId the job was started on", - "examples": [ - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - } - } - }, - "preAutomationTime": { - "type": "integer", - "title": "Pre automation time of automation", - "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", - "examples": [5000, 250000] - }, - "metrics": { - "type": "array", - "title": "Weekly aggregate metrics", - "description": "Aggregate job metrics collected on a weekly basis", - "items": { - "type": "object", - "properties": { - "jobsComplete": { - "type": "integer", - "title": "Jobs complete for automation", - "description": "Total number of jobs complete for automation for the week starting at startDate.", - "minimum": 0, - "examples": [10, 40] - }, - "totalRunTime": { - "type": "integer", - "title": "Total run time for automation", - "description": "Total run time (milliseconds) of jobs complete for automation for the week starting at startDate.", - "minimum": 0, - "examples": [200, 700] - }, - "totalManualTime": { - "type": "integer", - "title": "Total manual time for automation", - "description": "Total time (milliseconds) spent working manual a task for automation for the week starting at startDate.", - "minimum": 0, - "examples": [200, 700] - }, - "slaTargetsMissed": { - "type": "integer", - "title": "Sla targets missed for automation.", - "description": "Total number of sla targets that were missed for an automation for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - }, - "startDate": { - "type": "string", - "title": "Start DateTime of metric collection", - "description": "Metrics are collected on a weekly interval, starting at startDate", - "examples": [ - "2018-08-02T15:56:12.912Z", - "2019-09-06T12:52:24.933Z" - ] - } - }, - "required": [ - "jobsComplete", - "totalRunTime", - "totalManualTime", - "slaTargetsMissed", - "startDate" - ] - } - } - }, - "required": ["_id", "workflow", "metrics"] - }, - "workflow_engine_taskMetricsDocument": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Default metrics schema", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "app": { - "type": "string", - "title": "The associated app for this task", - "examples": ["WorkflowBuilder"] - }, - "name": { - "type": "string", - "title": "The name of the task", - "examples": ["getTime", "testTask"] - }, - "taskType": { - "type": "string", - "title": "The type of the task", - "enum": ["automatic", "manual", "operation"] - }, - "global": { - "type": "boolean", - "title": "Global task", - "description": "Global designating if metric is global across automations or per-automation.", - "examples": [true, false] - }, - "taskId": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$|^workflow_start$|^workflow_end$", - "title": "Workflow task id", - "description": "Four character hexadecimal task identifier", - "examples": ["12ab", "cd34"] - }, - "workflow": { - "type": "object", - "title": "Automation the job was started on.", - "properties": { - "name": { - "type": "string", - "title": "Name of the automation the job was started on", - "examples": ["exampleAutomationName"] - } - } - }, - "metrics": { - "type": "array", - "title": "Weekly aggregate metrics", - "description": "Aggregate job metrics collected on a weekly basis", - "items": { - "type": "object", - "properties": { - "startDate": { - "type": "string", - "title": "Start DateTime of metric collection", - "description": "Metrics are collected on a weekly interval, starting at startDate.", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "totalSuccesses": { - "type": "integer", - "title": "Total successes for a task", - "description": "Total number of tasks that ended in status success for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - }, - "totalSuccessRunTime": { - "type": "integer", - "title": "Total successes run time for a task", - "description": "Total run time (milliseconds) for tasks that ended in status success for the week starting at startDate.", - "minimum": 0, - "examples": [550, 200] - }, - "totalErrors": { - "type": "integer", - "title": "Total errors for a task", - "description": "Total number of tasks that ended in status error for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - }, - "totalErrorRunTime": { - "type": "integer", - "title": "Total error run time for a task", - "description": "Total run time (milliseconds) for tasks that ended in status error for the week starting at startDate.", - "minimum": 0, - "examples": [550, 200] - }, - "totalFailures": { - "type": "integer", - "title": "Total failures for a task", - "description": "Total number of tasks that ended in status failure for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - }, - "totalFailureRunTime": { - "type": "integer", - "title": "Total failure run time for a task", - "description": "Total run time (milliseconds) for tasks that ended in status failure for the week starting at startDate.", - "minimum": 0, - "examples": [550, 200] - }, - "slaTargetsMissed": { - "type": "integer", - "title": "Sla targets missed for a manual task", - "description": "Total number of sla targets that were missed for a manual task for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - } - }, - "required": [ - "startDate", - "totalSuccesses", - "totalSuccessRunTime", - "totalErrorRunTime", - "totalErrors", - "totalFailureRunTime", - "totalFailures" - ] - } - } - }, - "required": [ - "_id", - "app", - "name", - "type", - "taskType", - "global", - "metrics" - ] - }, - "workflow_engine_wfEngineCommon_skip": { - "type": "integer", - "description": "The number of documents skipped before returning data. When 0, no data is skipped.", - "minimum": 0, - "examples": [0] - }, - "workflow_engine_wfEngineCommon_limit": { - "type": "integer", - "title": "The returned document limit", - "description": "Specifies a limit to the maximum number of data results returned.", - "minimum": 0, - "maximum": 100, - "examples": [50] - }, - "workflow_engine_wfEngineCommon_sort": { - "type": "string", - "description": "Field to sort by. Default is workflow.name.", - "default": "workflow.name" - }, - "workflow_engine_wfEngineCommon_order": { - "type": "integer", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "default": 1, - "enum": [-1, 1] - }, - "workflow_engine_wfEngineCommon_total": { - "type": "integer", - "description": "The total number of documents returned from a search.", - "minimum": 0, - "examples": [100] - }, - "workflow_engine_wfEngineCommon_evaluationItem": { - "type": "object", - "title": "Evaluation Object", - "description": "Contains all the items/properties needed for a comparison operation/evaluation", - "required": ["operand_1", "operator", "operand_2"], - "properties": { - "query": { - "type": "string", - "title": "Query for first operand", - "description": "Query the operand_1 (optional)", - "examples": [ - "somePropertyNameInOperand_1IfItIsAnObject.nestedProperty" - ] - }, - "rightQuery": { - "type": "string", - "title": "Query for second operand", - "description": "Query the operand_2 (optional)", - "examples": [ - "somePropertyNameInOperand_2IfItIsAnObject.nestedProperty" - ] - }, - "operand_1": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "boolean" - }, - { - "type": "number" - } - ], - "title": "A comparison value", - "description": "Used in evaluations as either the object to compare, or the object to compare to" - }, - "operator": { - "type": "string", - "enum": ["contains", "!contains", "<", "<=", ">", ">=", "==", "!="], - "title": "The Operator ", - "description": "The operation (contains, !contains, <,<=, etc)", - "examples": ["contains"] - }, - "operand_2": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "boolean" - }, - { - "type": "number" - } - ], - "title": "A comparison value", - "description": "Used in evaluations as either the object to compare, or the object to compare to" - } - } - }, - "workflow_engine_wfEngineCommon_mongoObjectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "json-forms_formBindingSchema_bindingSchema": { - "type": "object" - }, - "json-forms_formDocument_form": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2019-04-16T00:43:22.038Z"] - }, - "createdBy": { - "type": "string", - "examples": ["5cb08d4f16640f00182c3890"] - }, - "lastUpdated": { - "type": "string", - "format": "date-time", - "examples": ["2019-04-16T00:43:22.038Z"] - }, - "lastUpdatedBy": { - "type": "string", - "examples": ["5cb08d4f16640f00182c3890"] - }, - "name": { - "type": "string", - "examples": ["Device Form"] - }, - "tags": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - { - "type": "object" - } - ] - } - }, - "description": { - "anyOf": [ - { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - { - "type": "null" - } - ] - }, - "struct": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "projectId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "required": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "array" - } - ] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "This section describes the connection information for a device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": [ - "Enter connection retry attempt count" - ] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - }, - "collapsed": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "schemaOption": { - "type": "boolean" - }, - "combinationType": { - "type": "string" - }, - "widget": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "items"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "required": ["type", "items"], - "additionalProperties": false, - "definitions": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "container": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "required": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "array" - } - ] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "This section describes the connection information for a device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "required": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "array" - } - ] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "This section describes the connection information for a device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": [ - "Enter connection retry attempt count" - ] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - }, - "collapsed": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "schemaOption": { - "type": "boolean" - }, - "combinationType": { - "type": "string" - }, - "widget": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "items"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": [ - "Enter connection retry attempt count" - ] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - }, - "collapsed": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "schemaOption": { - "type": "boolean" - }, - "combinationType": { - "type": "string" - }, - "widget": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "items"], - "additionalProperties": false - }, - "checkboxField": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": ["Is a timeout allowed to pass this step?"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - }, - "numberField": { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - "textField": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - "textareaField": { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - "dropdownField": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - "fileUploadField": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - } - } - }, - "schema": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "readOnly": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file."] - }, - "format": { - "type": "string", - "const": "data-url" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - } - }, - "readOnly": { - "type": "boolean" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - } - } - }, - "anyOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "oneOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "allOf": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["type", "title"] - }, - "uiSchema": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "ui:widget": { - "type": "string", - "const": "updown" - } - }, - "required": ["ui:widget"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's config"] - }, - "ui:widget": { - "type": "string", - "const": "textarea" - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Select device"] - } - } - } - ] - } - } - }, - "validationSchema": { - "type": "object" - }, - "bindingSchema": { - "type": "object" - }, - "version": { - "type": "string", - "examples": ["2020.1"] - }, - "id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ] - } - }, - "required": [ - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy", - "name", - "description", - "struct", - "schema", - "uiSchema", - "bindingSchema", - "validationSchema", - "version" - ], - "additionalProperties": false - }, - "json-forms_formDocument_formId": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "json-forms_formDocument_formData": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - }, - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ] - } - } - }, - "json-forms_formDocument_validationResponse": { - "type": "object", - "properties": { - "status": { - "type": "integer", - "enum": [200, 404] - }, - "validation": { - "type": "object", - "properties": { - "valid": { - "type": "boolean" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "message": { - "type": "string", - "examples": ["Form data is valid."] - } - } - }, - "json-forms_formDocument_importResultReport": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2019-04-16T00:43:22.038Z"] - }, - "createdBy": { - "type": "string", - "examples": ["5cb08d4f16640f00182c3890"] - }, - "lastUpdated": { - "type": "string", - "format": "date-time", - "examples": ["2019-04-16T00:43:22.038Z"] - }, - "lastUpdatedBy": { - "type": "string", - "examples": ["5cb08d4f16640f00182c3890"] - }, - "name": { - "type": "string", - "examples": ["Device Form"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - } - } - }, - "json-forms_formSchema_container": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "readOnly": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "readOnly": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file."] - }, - "format": { - "type": "string", - "const": "data-url" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - } - }, - "readOnly": { - "type": "boolean" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - } - } - } - }, - "anyOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "oneOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "allOf": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["type", "title"] - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": ["Is a timeout allowed to pass this step?"] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file."] - }, - "format": { - "type": "string", - "const": "data-url" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - } - }, - "readOnly": { - "type": "boolean" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "readOnly": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file."] - }, - "format": { - "type": "string", - "const": "data-url" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - } - }, - "items": {}, - "anyOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "oneOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "allOf": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["type", "title"] - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - } - } - }, - "anyOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "oneOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "allOf": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["type", "title"] - }, - "json-forms_formStruct": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "projectId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "required": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "array" - } - ] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "This section describes the connection information for a device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": [ - "Enter connection retry attempt count" - ] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - }, - "collapsed": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "schemaOption": { - "type": "boolean" - }, - "combinationType": { - "type": "string" - }, - "widget": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "items"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": ["Is a timeout allowed to pass this step?"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "required": ["type", "items"], - "additionalProperties": false - }, - "json-forms_formUISchema_container": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "ui:widget": { - "type": "string", - "const": "updown" - } - }, - "required": ["ui:widget"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's config"] - }, - "ui:widget": { - "type": "string", - "const": "textarea" - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Select device"] - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "ui:widget": { - "type": "string", - "const": "updown" - } - }, - "required": ["ui:widget"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's config"] - }, - "ui:widget": { - "type": "string", - "const": "textarea" - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Select device"] - } - } - } - ] - } - } - }, - "json-forms_formValidationSchema_validationSchema": { - "type": "object" - }, - "json-forms_metaSchema": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "type": "object", - "properties": { - "$id": { - "type": "string", - "format": "uri-reference" - }, - "$schema": { - "type": "string", - "format": "uri" - }, - "$ref": { - "type": "string", - "format": "uri-reference" - }, - "$comment": { - "type": "string" - }, - "title": { - "type": "string" - }, - "description": { - "type": "string" - }, - "default": {}, - "readOnly": { - "type": "boolean", - "default": false - }, - "examples": { - "type": "array", - "items": {} - }, - "multipleOf": { - "type": "number", - "exclusiveMinimum": 0 - }, - "maximum": { - "type": "number" - }, - "exclusiveMaximum": { - "type": "number" - }, - "minimum": { - "type": "number" - }, - "exclusiveMinimum": { - "type": "number" - }, - "maxLength": { - "type": "integer", - "minimum": 0 - }, - "minLength": { - "allOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "default": 0 - } - ] - }, - "pattern": { - "type": "string", - "format": "regex" - }, - "additionalItems": {}, - "items": { - "anyOf": [ - {}, - { - "type": "array", - "minItems": 1, - "items": {} - } - ], - "default": true - }, - "maxItems": { - "type": "integer", - "minimum": 0 - }, - "minItems": { - "allOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "default": 0 - } - ] - }, - "uniqueItems": { - "type": "boolean", - "default": false - }, - "contains": {}, - "maxProperties": { - "type": "integer", - "minimum": 0 - }, - "minProperties": { - "allOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "default": 0 - } - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true, - "default": [] - }, - "additionalProperties": {}, - "definitions": { - "type": "object", - "additionalProperties": {}, - "default": {} - }, - "properties": { - "type": "object", - "additionalProperties": {}, - "default": {} - }, - "patternProperties": { - "type": "object", - "additionalProperties": {}, - "propertyNames": { - "format": "regex" - }, - "default": {} - }, - "dependencies": { - "type": "object", - "additionalProperties": { - "anyOf": [ - {}, - { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true, - "default": [] - } - ] - } - }, - "propertyNames": {}, - "const": {}, - "enum": { - "type": "array", - "items": {}, - "minItems": 1, - "uniqueItems": true - }, - "type": { - "anyOf": [ - { - "enum": [ - "array", - "boolean", - "integer", - "null", - "number", - "object", - "string" - ] - }, - { - "type": "array", - "items": { - "enum": [ - "array", - "boolean", - "integer", - "null", - "number", - "object", - "string" - ] - }, - "minItems": 1, - "uniqueItems": true - } - ] - }, - "format": { - "type": "string" - }, - "contentMediaType": { - "type": "string" - }, - "contentEncoding": { - "type": "string" - }, - "if": {}, - "then": {}, - "else": {}, - "allOf": { - "type": "array", - "minItems": 1, - "items": {} - }, - "anyOf": { - "type": "array", - "minItems": 1, - "items": {} - }, - "oneOf": { - "type": "array", - "minItems": 1, - "items": {} - }, - "not": {} - } - } - ] - }, - "workflow_builder_workflowDocument": { - "title": "workflow document", - "description": "A workflow document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - "name": { - "type": "string", - "examples": ["My Workflow"] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - } - } - } - } - } - ] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - }, - "workflow_end": { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "x": { - "type": "number", - "examples": [10] - }, - "y": { - "type": "number", - "examples": [20] - } - } - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "additionalProperties": false - }, - "errorHandler": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - ] - }, - "font_size": { - "type": "integer", - "default": 12, - "multipleOf": 2, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time" - }, - "created_by": {}, - "createdVersion": { - "type": "string", - "examples": ["5.40.5-2021.1.72.0"] - }, - "last_updated": { - "type": "string", - "format": "date-time" - }, - "last_updated_by": {}, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "canvasVersion": { - "type": "number", - "enum": [1, 1.5, 2, 3] - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - }, - "inputSchema": { - "type": "object" - }, - "outputSchema": { - "type": "object" - }, - "outputData": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "taskId": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$" - }, - "taskPointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "additionalProperties": false, - "required": ["name", "type", "tasks", "transitions", "groups"] - }, - "workflow_builder_workflowDocument_workflowName": { - "type": "string", - "examples": ["My Workflow"] - }, - "workflow_builder_workflowDocument_anyTask": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - } - ] - }, - "workflow_builder_workflowPayload": { - "title": "workflow import payload", - "description": "A workflow import payload, that has expanded users and groups for transportation between environments", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - "name": { - "type": "string", - "examples": ["ciscoIOSSoftwareUpgrade", "infobloxCreateARecord"] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": [ - "Upgrade Cisco IOS device", - "Infoblox Create A Record" - ] - } - ] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string", - "examples": ["New Relic", "Cisco", "AWS/EC2"] - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - } - } - } - } - } - ] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - }, - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - }, - "workflow_end": { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - }, - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string" - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "additionalProperties": false - }, - "errorHandler": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - ] - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": { - "oneOf": [ - { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["username", "provenance"] - }, - { - "type": "null" - } - ] - }, - "createdVersion": { - "type": "string", - "examples": ["5.40.5-2021.1.72.0"] - }, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": { - "oneOf": [ - { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["username", "provenance"] - }, - { - "type": "null" - } - ] - }, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "required": ["_id", "name", "description"] - } - }, - "canvasVersion": { - "type": "number", - "enum": [1, 1.5, 2, 3] - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - }, - "inputSchema": { - "type": "object" - }, - "outputSchema": { - "type": "object" - }, - "outputData": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "taskId": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$" - }, - "taskPointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - }, - "migrationVersion": { - "type": "integer", - "minimum": 0 - } - }, - "additionalProperties": false, - "required": ["name", "type", "tasks", "transitions", "groups"] - }, - "template_builder_parseTemplateInput": { - "title": "parse template input", - "description": "The text data to be parse and the textfsm template", - "type": "object", - "properties": { - "text": { - "type": "string", - "examples": ["hostname"] - }, - "template": { - "title": "template document", - "description": "A template document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "name": { - "type": "string", - "examples": ["My Template"] - }, - "device": { - "type": "string", - "examples": ["Device Group A"] - }, - "command": { - "type": "string", - "examples": ["show hostname"] - }, - "template": { - "type": "string", - "examples": [ - "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record" - ] - }, - "text": { - "type": "string", - "examples": ["hostname"] - }, - "type": { - "type": "string", - "const": "custom" - } - }, - "required": [ - "name", - "device", - "command", - "template", - "text", - "type" - ], - "definitions": { - "templateName": { - "type": "string", - "examples": ["My Template"] - }, - "groupName": { - "type": "string", - "examples": ["Device Group A"] - }, - "command": { - "type": "string", - "examples": ["show hostname"] - }, - "template": { - "type": "string", - "examples": [ - "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record" - ] - }, - "text": { - "type": "string", - "examples": ["hostname"] - }, - "ObjectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - "required": ["text", "template"] - }, - "operations-manager_automation-api": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Automation Document", - "description": "An Automation document in API response format.", - "required": [ - "name", - "description", - "componentType", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "_id", - "gbac" - ], - "oneOf": [ - { - "required": ["componentId"], - "not": { - "required": ["componentName"] - } - }, - { - "required": ["componentName"], - "not": { - "required": ["componentId"] - } - }, - { - "required": ["componentId", "componentName"] - } - ], - "propertyNames": { - "anyOf": [ - { - "enum": ["name", "description", "componentType"] - }, - { - "enum": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] - }, - { - "enum": ["_id", "gbac", "componentName", "componentId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group ids that have write access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "read": { - "type": "array", - "description": "An array of group ids that have read/execute access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "componentId": { - "description": "The id of the component linked to this Automation.", - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - }, - { - "const": "" - } - ] - }, - "componentName": { - "description": "The name of the component linked to this Automation.", - "oneOf": [ - { - "type": "string", - "examples": ["addDuration", "getJobMetrics"] - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - "operations-manager_automation-common_commonFields": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - "operations-manager_automation-common_gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group ids that have write access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "read": { - "type": "array", - "description": "An array of group ids that have read/execute access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "operations-manager_automation-common_componentId": { - "description": "The id of the component linked to this Automation.", - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - }, - { - "const": "" - } - ] - }, - "operations-manager_automation-create": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Automation Create", - "description": "The format of accepted input for the creation of an Automation document.", - "required": ["name"], - "propertyNames": { - "anyOf": [ - { - "enum": ["name", "description", "componentType"] - }, - { - "enum": [ - "gbac", - "componentId", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy", - "componentName" - ] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group ids that have write access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "read": { - "type": "array", - "description": "An array of group ids that have read/execute access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "componentId": { - "description": "The id of the component linked to this Automation.", - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - }, - { - "const": "" - } - ] - } - } - } - ] - }, - "operations-manager_automation-json": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Automation Document", - "description": "An Automation document in JSON/export format.", - "required": [ - "name", - "description", - "componentType", - "_id", - "gbac", - "componentName" - ], - "propertyNames": { - "anyOf": [ - { - "enum": ["name", "description", "componentType"] - }, - { - "enum": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] - }, - { - "enum": ["_id", "gbac", "triggers", "componentName"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group objects that have write access to the Automation.", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "examples": ["ldap", "localAAA"] - }, - "name": { - "type": "string", - "examples": ["operators", "admins", "designers"] - }, - "description": { - "type": "string", - "examples": ["Description of a group"] - } - }, - "required": ["provenance", "name", "description"] - } - }, - "read": { - "type": "array", - "description": "An array of group objects that have read/execute access to the Automation.", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "examples": ["ldap", "localAAA"] - }, - "name": { - "type": "string", - "examples": ["operators", "admins", "designers"] - }, - "description": { - "type": "string", - "examples": ["Description of a group"] - } - }, - "required": ["provenance", "name", "description"] - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "triggers": { - "type": "array", - "items": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger", - "description": "An Endpoint Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "verb", - "routeName", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger", - "description": "An EventSystem Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "source", - "topic", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "source", - "topic", - "schema", - "legacyWrapper" - ] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger", - "description": "A Manual Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "formData", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper" - ] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Triggers Schema for JSON Representation", - "description": "Schema for a Schedule Trigger JSON representation", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "formData", - "firstRunAt", - "processMissedRuns", - "repeatUnit", - "repeatFrequency", - "repeatInterval", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": [ - "repeating", - "terminating" - ] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [ - 30, 140, 2000 - ] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [ - 10000, 30000, 100000 - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [ - 30, 140, 2000 - ] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [ - 10000, 30000, 100000 - ] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - } - }, - "componentName": { - "description": "The name of the component linked to this Automation.", - "oneOf": [ - { - "type": "string", - "examples": ["addDuration", "getJobMetrics"] - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - "operations-manager_automation-update": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Automation Updates", - "description": "The format of accepted input for an update operation on an Automation document.", - "propertyNames": { - "anyOf": [ - { - "enum": ["name", "description", "componentType"] - }, - { - "enum": [ - "gbac", - "componentId", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy", - "componentName" - ] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group ids that have write access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "read": { - "type": "array", - "description": "An array of group ids that have read/execute access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "componentId": { - "description": "The id of the component linked to this Automation.", - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - }, - { - "const": "" - } - ] - } - } - } - ] - }, - "operations-manager_common-api_pagination-metadata": { - "description": "Properties describing search result pagination", - "type": "object", - "properties": { - "skip": { - "type": "integer" - }, - "limit": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "nextPageSkip": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "integer" - } - ] - }, - "previousPageSkip": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "integer" - } - ] - }, - "currentPageSize": { - "type": "integer" - } - } - }, - "operations-manager_common-api_success-response": { - "description": "A success response from an API method", - "type": "object", - "additionalProperties": false, - "required": ["message", "data", "metadata"], - "properties": { - "message": { - "description": "A human-readable message summarizing the result of the operation", - "type": "string", - "examples": [ - "Successfully created the requested item", - "Successfully imported 3 of 4 documents", - "Successfully retrieved search results", - "Successfully added group 679cebd0502a4abd9a57a6ba to job 13861e352afe454d89cccfb8", - "Successfully canceled all jobs" - ] - }, - "data": { - "description": "Any successfully retrieved information related to the request." - }, - "metadata": { - "description": "Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.", - "type": "object", - "additionalProperties": true - } - } - }, - "operations-manager_common-api_getJobsQueryParameters": { - "title": "getJobsQueryParameters", - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - }, - "skip": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - }, - "order": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - }, - "sort": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - }, - "include": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - }, - "exclude": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - }, - "in": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string" - }, - "not-in": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string" - }, - "equals": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string" - }, - "contains": { - "description": "Returns results where the specified fields contain the given match string(s). When used on the 'description' field, returns results containing any matching whole word, delimited by most punctuation. Double-quotes may be used to match phrases rather than individual words.", - "type": "string" - }, - "starts-with": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string" - }, - "ends-with": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string" - }, - "dereference": { - "description": "Designates foreign key fields to dereference in the API output.", - "type": "string" - }, - "gt": { - "description": "Returns results where the specified fields have values greater than the specified values.", - "type": "string" - }, - "gte": { - "description": "Returns results where the specified fields have values greater than or equal to the specified values.", - "type": "string" - }, - "lt": { - "description": "Returns results where the specified fields have values less than the specified values.", - "type": "string" - }, - "lte": { - "description": "Returns results where the specified fields have values less than or equal to the specified values.", - "type": "string" - }, - "q": { - "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", - "type": "string" - }, - "exists": { - "description": "Returns results where the specified fields exist according to the specified value.", - "type": "string" - } - } - }, - "operations-manager_common-api_simplePluralSearchQueryParameters": { - "type": "object", - "properties": { - "contains": { - "type": "string", - "examples": ["event"], - "description": "The value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document" - }, - "containsField": { - "type": "string", - "examples": ["name"], - "description": "The field to run a contains query on" - }, - "equals": { - "type": "string", - "examples": ["my event trigger"], - "description": "The value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document" - }, - "equalsField": { - "type": "string", - "examples": ["name"], - "description": "The field to run an equals query on" - }, - "startsWith": { - "type": "string", - "examples": ["my"], - "description": "The value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document" - }, - "startsWithField": { - "type": "string", - "examples": ["name"], - "description": "The field to run a startsWith query on" - }, - "limit": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - }, - "skip": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - }, - "order": { - "type": "integer", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "default": 1, - "enum": [-1, 1] - }, - "sort": { - "type": "string", - "description": "Field to sort by. Default is name.", - "default": "name", - "enum": ["name"] - } - } - }, - "operations-manager_common_name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "operations-manager_common_ObjectIdLikeString": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "operations-manager_common_uuid-v4": { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - "operations-manager_common_decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "operations-manager_common_metadataFields": { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "operations-manager_eventSystem-trigger-common_source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "operations-manager_eventSystem-trigger-common_topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "operations-manager_job-api": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Job Document", - "description": "A Job document in API response format.", - "$comment": "No required fields, because projection operators can result in any combination of fields", - "required": [], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "_id", - "font_size", - "type", - "created", - "last_updated", - "createdVersion", - "lastUpdatedVersion", - "canvasVersion", - "encodingVersion", - "migrationVersion", - "name", - "description", - "preAutomationTime", - "sla", - "decorators", - "transitions", - "status", - "variables", - "tags", - "error", - "warnings", - "ancestors", - "validationErrors", - "namespace" - ] - }, - { - "enum": [ - "created_by", - "last_updated_by", - "tasks", - "parent", - "errorHandler", - "groups", - "watchers", - "metrics", - "output", - "outputData", - "errors", - "warnings" - ] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "font_size": { - "type": "integer", - "examples": [12, 13, 14] - }, - "type": { - "enum": ["automation", "resource:action", "resource:compliance"] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "last_updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "createdVersion": { - "type": "string", - "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$", - "examples": ["5.55.5"] - }, - "lastUpdatedVersion": { - "type": "string", - "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$", - "examples": ["5.55.6"] - }, - "canvasVersion": { - "enum": [1, 1.5, 2, 3] - }, - "encodingVersion": { - "enum": [1] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "oneOf": [ - { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "number", - "examples": [0] - }, - "sla": { - "type": "number", - "examples": [0] - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "transitions": { - "type": "object" - }, - "status": { - "enum": [ - "error", - "complete", - "running", - "canceled", - "incomplete", - "paused" - ] - }, - "variables": { - "type": "object", - "examples": [ - { - "initiator": { - "location": "job_data", - "_id": "67be20c2dda0df69ebe60826" - }, - "_id": { - "location": "job_data", - "_id": "67be20c2dda0df69ebe60825" - } - } - ] - }, - "tags": { - "type": "array" - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "const": "job" - }, - { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["workflow_start", "e28f", "3a1f"] - } - ] - } - ] - }, - "message": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - } - ] - }, - "timestamp": { - "type": "number", - "description": "The time at which this error occurred, designated by a unix timestamp" - } - }, - "examples": [ - { - "task": "f9a9", - "message": { - "code": 500, - "message": { - "apiVersion": "1", - "method": "transformations.run", - "error": { - "code": 500, - "message": "Missing one of the following required instances: arg2, arg1", - "errors": [{}] - } - } - }, - "timestamp": 1627323002561 - }, - { - "task": "job", - "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", - "timestamp": 1627323002574 - } - ] - } - }, - "warnings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["workflow_start", "e28f", "3a1f"] - } - ] - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "message": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - } - ] - } - } - } - }, - "ancestors": { - "oneOf": [ - { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "type": "null" - } - ] - }, - "validationErrors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "keyword": { - "type": "string" - }, - "instancePath": { - "type": "string" - }, - "schemaPath": { - "type": "string" - }, - "params": { - "type": "object" - }, - "message": { - "type": "string" - } - } - } - }, - "namespace": { - "type": "object" - } - } - }, - { - "type": "object", - "properties": { - "created_by": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - "last_updated_by": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "workflow_start" - }, - "summary": { - "const": "workflow_start" - }, - "taskId": { - "const": "workflow_start" - }, - "metrics": { - "type": "object", - "properties": { - "start_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "metrics": { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - } - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - }, - "workflow_end": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "workflow_end" - }, - "summary": { - "const": "workflow_end" - }, - "taskId": { - "const": "workflow_end" - }, - "endTasks": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "metrics": { - "type": "object", - "properties": { - "end_time": { - "type": "number" - }, - "run_time": { - "type": "number" - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "operation" - }, - "canvasName": { - "not": { - "const": "childJob" - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - }, - { - "type": "object", - "properties": { - "actor": { - "oneOf": [ - { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - { - "const": "job" - } - ] - }, - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "allOf": [ - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "view": { - "type": "string" - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "automatic" - }, - "actor": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "const": "job" - }, - { - "$comment": "Job variable", - "type": "string", - "pattern": "^\\$var\\.job\\.[a-zA-Z_0-9]{1,}$" - }, - { - "$comment": "Task reference", - "type": "string", - "pattern": "^\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - } - ] - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "operation" - }, - "canvasName": { - "not": { - "const": "childJob" - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "canvasName": { - "const": "childJob" - }, - "loop": { - "type": "object", - "properties": { - "atLeastOneComplete": { - "type": "boolean" - }, - "finishedCount": { - "type": "number" - }, - "isFinished": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^[0-9a-fA-F]{24}$": { - "type": "boolean" - } - } - }, - "outgoing": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "childJobLoopIndex": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "value": { - "type": "integer" - } - } - }, - "_id": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "_id": { - "type": "string" - } - } - }, - "initiator": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "_id": { - "type": "string" - } - } - } - } - }, - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - }, - "childJobs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "iteration": { - "type": "number" - } - } - } - } - } - } - ] - } - ] - }, - { - "type": "object", - "properties": { - "actor": { - "oneOf": [ - { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - { - "const": "job" - } - ] - }, - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - } - } - }, - "parent": { - "type": "object", - "properties": { - "job": { - "oneOf": [ - { - "type": "string", - "examples": ["fe7043ac41d24206aa556c49"] - }, - { - "type": "object", - "description": "A single job-api object without a parent.job of type object" - } - ] - }, - "task": { - "type": "string", - "examples": ["defc"] - }, - "iteration": { - "type": "number", - "examples": [1] - }, - "element": { - "type": "number", - "examples": [0] - } - } - }, - "errorHandler": { - "oneOf": [ - { - "type": "null" - }, - { - "allOf": [ - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "view": { - "type": "string" - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "automatic" - }, - "actor": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "const": "job" - }, - { - "$comment": "Job variable", - "type": "string", - "pattern": "^\\$var\\.job\\.[a-zA-Z_0-9]{1,}$" - }, - { - "$comment": "Task reference", - "type": "string", - "pattern": "^\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - } - ] - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "operation" - }, - "canvasName": { - "not": { - "const": "childJob" - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "canvasName": { - "const": "childJob" - }, - "loop": { - "type": "object", - "properties": { - "atLeastOneComplete": { - "type": "boolean" - }, - "finishedCount": { - "type": "number" - }, - "isFinished": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^[0-9a-fA-F]{24}$": { - "type": "boolean" - } - } - }, - "outgoing": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "childJobLoopIndex": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "value": { - "type": "integer" - } - } - }, - "_id": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "_id": { - "type": "string" - } - } - }, - "initiator": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "_id": { - "type": "string" - } - } - } - } - }, - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - }, - "childJobs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "iteration": { - "type": "number" - } - } - } - } - } - } - ] - } - ] - }, - { - "type": "object", - "properties": { - "actor": { - "oneOf": [ - { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - { - "const": "job" - } - ] - }, - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - } - ] - }, - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "watchers": { - "type": "array", - "items": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - } - }, - "metrics": { - "allOf": [ - { - "type": "object", - "properties": { - "start_time": { - "type": "number" - }, - "progress": { - "type": "number", - "minimum": 0, - "maximum": 1 - }, - "end_time": { - "type": "number" - } - } - }, - { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - "owner": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - "output": { - "type": "object" - }, - "outputData": { - "type": "object" - } - } - } - ] - }, - "operations-manager_job-common_taskId": { - "oneOf": [ - { - "enum": ["workflow_start", "workflow_end", "error_handler"] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["workflow_start", "e28f", "3a1f"] - } - ] - }, - "operations-manager_task-api": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Task Document", - "description": "A Task document in API response format.", - "$comment": "No required fields, because projection operators can result in any combination of fields", - "required": [], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "_id", - "location", - "view", - "status", - "app", - "name", - "variables", - "last_updated", - "encodingVersion", - "job", - "incomingRefs" - ] - }, - { - "enum": ["groups", "type", "metrics", "incomingRefs"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - "location": { - "enum": ["Adapter", "Application", "Broker"] - }, - "view": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["/workflow_engine/task/ViewData"] - } - ] - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "app": { - "type": "string", - "examples": ["WorkFlowEngine"] - }, - "name": { - "type": "string", - "examples": ["ViewData", "Stub", "Eval"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "last_updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "encodingVersion": { - "enum": [1] - }, - "job": { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "task": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["e28f", "3a1f", "b4f"] - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["View Task Data"] - } - ] - }, - "ancestors": { - "oneOf": [ - { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "type": "null" - } - ] - } - } - }, - "incomingRefs": { - "type": "array" - } - } - }, - { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "metrics": { - "allOf": [ - { - "type": "object", - "properties": { - "start_time": { - "type": "string", - "example": ["2025-03-11T19:03:31.515Z"] - }, - "claim_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number", - "examples": [1740438512495] - }, - "server_id": { - "type": "string", - "examples": [ - "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" - ] - }, - "finish_state": { - "oneOf": [ - { - "const": "success" - }, - { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - } - ] - }, - "run_time": { - "type": "number", - "examples": [5] - } - } - }, - { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - }, - "owner": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "operation" - }, - "metrics": { - "allOf": [ - { - "type": "object", - "properties": { - "start_time": { - "type": "string", - "example": ["2024-03-11T19:03:31.515Z"] - }, - "end_time": { - "type": "number", - "example": [1740438512495] - }, - "server_id": { - "type": "string", - "examples": [ - "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" - ] - }, - "finish_state": { - "oneOf": [ - { - "const": "success" - }, - { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - } - ] - }, - "run_time": { - "type": "number", - "examples": [6] - }, - "retrying": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - }, - "owner": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "automatic" - }, - "metrics": { - "allOf": [ - { - "type": "object", - "properties": { - "start_time": { - "type": "string", - "example": ["2024-03-11T19:03:31.515Z"] - }, - "end_time": { - "type": "number", - "example": [1740438512495] - }, - "server_id": { - "type": "string", - "examples": [ - "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" - ] - }, - "finish_state": { - "oneOf": [ - { - "const": "success" - }, - { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - } - ] - }, - "run_time": { - "type": "number", - "examples": [6] - }, - "retrying": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - }, - "owner": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - } - } - } - ] - } - } - } - ] - } - ] - }, - "operations-manager_task-common_taskId": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["e28f", "3a1f", "b4f"] - }, - "operations-manager_trigger-api": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger", - "description": "An Endpoint Trigger in API response format.", - "required": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "lastExecuted", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "verb", - "routeName", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger", - "description": "An EventSystem Trigger in API response format.", - "required": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "lastExecuted", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "source", - "topic", - "schema", - "legacyWrapper", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["source", "topic", "schema", "legacyWrapper"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger", - "description": "A Manual Trigger in API response format.", - "required": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "lastExecuted", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "formData", - "legacyWrapper", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["formData", "formSchemaHash", "legacyWrapper"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Trigger", - "description": "A Schedule Trigger in API response format.", - "required": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "lastExecuted", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "formData", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "processMissedRuns", - "locked", - "repeatUnit", - "repeatFrequency", - "repeatInterval", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": ["repeating", "terminating"] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - }, - "operations-manager_trigger-common_commonFields": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "operations-manager_trigger-create": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger Create", - "description": "The format of accepted input for the creation of an Endpoint Trigger.", - "required": ["name", "type", "routeName"], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger Create", - "description": "The format of accepted input for the creation of an EventSystem Trigger.", - "required": ["name", "type", "topic"], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["source", "topic", "schema", "legacyWrapper"] - }, - { - "enum": ["jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger Create", - "description": "The format of accepted input for the creation of a Manual Trigger.", - "required": ["name", "type"], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["formData", "formSchemaHash", "legacyWrapper"] - }, - { - "enum": ["formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Trigger Create", - "description": "The format of accepted input for the creation of a Schedule Trigger.", - "required": ["name", "type", "processMissedRuns"], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["formId"] - } - ] - }, - "oneOf": [ - { - "required": ["repeatUnit", "repeatFrequency"] - }, - { - "not": { - "required": ["repeatUnit", "repeatFrequency"] - } - } - ], - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": ["repeating", "terminating"] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - }, - "operations-manager_trigger-json": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger", - "description": "An Endpoint Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "verb", - "routeName", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger", - "description": "An EventSystem Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "source", - "topic", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["source", "topic", "schema", "legacyWrapper"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger", - "description": "A Manual Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "formData", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["formData", "formSchemaHash", "legacyWrapper"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Triggers Schema for JSON Representation", - "description": "Schema for a Schedule Trigger JSON representation", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "formData", - "firstRunAt", - "processMissedRuns", - "repeatUnit", - "repeatFrequency", - "repeatInterval", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": ["repeating", "terminating"] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - }, - "operations-manager_trigger-update": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger Updates", - "description": "The format of accepted input for an update operation on an Endpoint Trigger.", - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger Updates", - "description": "The format of accepted input for an update operation on an EventSystem Trigger.", - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": ["source", "topic", "schema", "legacyWrapper"] - }, - { - "enum": ["jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger Updates", - "description": "The format of accepted input for an update operation on a Manual Trigger.", - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": ["formData", "formSchemaHash", "legacyWrapper"] - }, - { - "enum": ["formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Trigger Updates", - "description": "The format of accepted input for an update operation on a Schedule Trigger.", - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["formId"] - } - ] - }, - "oneOf": [ - { - "required": ["repeatUnit", "repeatFrequency"] - }, - { - "not": { - "required": ["repeatUnit", "repeatFrequency"] - } - } - ], - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": ["repeating", "terminating"] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - }, - "mop_mopAnalyticTemplateDoc": { - "title": "mop analytic template", - "description": "A mop analytic template object", - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ] - }, - "os": { - "type": "string", - "examples": ["cisco-ios"] - }, - "passRule": { - "type": "boolean" - }, - "prepostCommands": { - "type": "array", - "items": { - "type": "object", - "properties": { - "preRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "postRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "passRule": { - "type": "boolean" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["regex"] - }, - "preRegex": { - "type": "string", - "examples": [""] - }, - "postRegex": { - "type": "string", - "examples": [""] - }, - "evaluation": { - "type": "string", - "examples": ["="] - } - } - } - }, - "preCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - }, - "postCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - } - } - } - }, - "created": { - "type": "integer", - "examples": [1508182880981] - }, - "createdBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - }, - "lastUpdated": { - "type": "integer", - "examples": [1508182880981] - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - } - }, - "required": ["name"] - }, - "mop_mopAnalyticTemplateDoc__id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "mop_mopAnalyticTemplateDoc_name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "mop_mopAnalyticTemplateDoc_successResponse": { - "type": "object", - "properties": { - "result": { - "type": "object", - "properties": { - "n": { - "type": "integer", - "examples": [1] - }, - "ok": { - "type": "integer", - "examples": [1] - } - } - }, - "ops": { - "type": "array", - "items": { - "title": "mop analytic template", - "description": "A mop analytic template object", - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ] - }, - "os": { - "type": "string", - "examples": ["cisco-ios"] - }, - "passRule": { - "type": "boolean" - }, - "prepostCommands": { - "type": "array", - "items": { - "type": "object", - "properties": { - "preRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "postRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "passRule": { - "type": "boolean" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["regex"] - }, - "preRegex": { - "type": "string", - "examples": [""] - }, - "postRegex": { - "type": "string", - "examples": [""] - }, - "evaluation": { - "type": "string", - "examples": ["="] - } - } - } - }, - "preCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - }, - "postCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - } - } - } - }, - "created": { - "type": "integer", - "examples": [1508182880981] - }, - "createdBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - }, - "lastUpdated": { - "type": "integer", - "examples": [1508182880981] - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - } - }, - "required": ["name"], - "definitions": { - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "projectNamespace": { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "_id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "prepostCommand": { - "type": "object", - "properties": { - "preRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "postRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "passRule": { - "type": "boolean" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["regex"] - }, - "preRegex": { - "type": "string", - "examples": [""] - }, - "postRegex": { - "type": "string", - "examples": [""] - }, - "evaluation": { - "type": "string", - "examples": ["="] - } - } - } - }, - "preCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - }, - "postCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - } - } - }, - "successResponse": { - "type": "object", - "properties": { - "result": { - "type": "object", - "properties": { - "n": { - "type": "integer", - "examples": [1] - }, - "ok": { - "type": "integer", - "examples": [1] - } - } - }, - "ops": { - "type": "array", - "items": {} - }, - "insertedCount": { - "type": "integer", - "examples": [1] - }, - "insertedIds": { - "type": "object", - "properties": { - "0": { - "type": "string", - "examples": ["TestAnalysisTemp"] - } - } - } - } - } - } - } - }, - "insertedCount": { - "type": "integer", - "examples": [1] - }, - "insertedIds": { - "type": "object", - "properties": { - "0": { - "type": "string", - "examples": ["TestAnalysisTemp"] - } - } - } - } - }, - "mop_mopTemplateDoc": { - "title": "mop template", - "description": "A mop template object", - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ] - }, - "os": { - "type": "string", - "examples": ["cisco-ios"] - }, - "passRule": { - "type": "boolean" - }, - "commands": { - "type": "array", - "items": { - "type": "object", - "properties": { - "command": { - "type": "string", - "examples": ["show running-config ip vrf"] - }, - "passRule": { - "type": "boolean" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "rule": { - "type": "string", - "examples": ["show version"] - }, - "eval": { - "type": "string", - "examples": ["contains"] - }, - "raw": { - "type": "string", - "examples": ["show version"] - }, - "result": { - "type": "boolean" - } - }, - "required": ["rule", "eval"] - } - } - } - } - }, - "created": { - "type": "integer", - "examples": [1508182880981] - }, - "createdBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - }, - "lastUpdated": { - "type": "integer", - "examples": [1508182880981] - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - } - }, - "required": ["name"] - }, - "mop_mopTemplateDoc__id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "mop_mopTemplateDoc_name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "mop_mopTemplateDoc_successResponse": { - "type": "object", - "properties": { - "n": { - "type": "integer", - "examples": [1] - }, - "ok": { - "type": "integer", - "examples": [1] - }, - "nModified": { - "type": "integer", - "examples": [1] - } - } - }, - "mop_mopTemplateDoc_variables": { - "type": "object", - "properties": {}, - "examples": [ - { - "device_name": "my-device1" - } - ] - }, - "mop_mopTemplateDoc_devices": { - "type": "array", - "items": { - "type": "string", - "examples": ["Device 2", "Device 1"] - } - }, - "mop_mopTemplateDoc_runCommandRes": { - "type": "object", - "properties": { - "raw": { - "type": "string", - "examples": ["show version"] - }, - "all_pass_flag": { - "type": "boolean" - }, - "evaluated": { - "type": "string", - "examples": ["show version"] - }, - "parameters": { - "type": "object", - "properties": {} - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "rule": { - "type": "string", - "examples": ["show version"] - }, - "eval": { - "type": "string", - "examples": ["contains"] - }, - "raw": { - "type": "string", - "examples": ["show version"] - }, - "result": { - "type": "boolean" - } - }, - "required": ["rule", "eval"] - } - }, - "device": { - "type": "string", - "examples": ["device1"] - }, - "response": { - "type": "string", - "examples": ["version: 10.0.0"] - }, - "result": { - "type": "boolean" - } - } - }, - "mop_mopTemplateDoc_device": { - "type": "string", - "examples": ["device1"] - }, - "mop_mopTemplateDoc_options": { - "type": "object", - "properties": { - "start": { - "type": "integer", - "examples": [0] - }, - "limit": { - "type": "integer", - "examples": [25] - }, - "entity": { - "type": "string", - "examples": ["device1"] - }, - "filter": { - "type": "string", - "examples": ["filter"] - }, - "sort": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "integer", - "examples": [1] - } - } - } - } - } - }, - "mop_mopTemplateDoc_detailedDevice": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "authgroup": { - "type": "string", - "examples": ["csr-aws", "default"] - }, - "address": { - "type": "string", - "examples": ["127.0.0.1"] - }, - "port": { - "type": "string", - "examples": ["12035"] - }, - "device-type": { - "type": "string", - "examples": ["netconf"] - }, - "ned": { - "type": "string", - "examples": ["nso46"] - }, - "admin": { - "type": "boolean" - }, - "host": { - "type": "string", - "examples": ["Local Host"] - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "examples": ["Group1"] - } - } - } - }, - "lifecycle-manager_common-http_document-identifier": { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - }, - "lifecycle-manager_common-http_pagination-metadata": { - "description": "Properties describing search result pagination", - "type": "object", - "properties": { - "skip": { - "type": "integer" - }, - "limit": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "nextPageSkip": { - "type": "integer" - }, - "previousPageSkip": { - "type": "integer" - }, - "currentPageSize": { - "type": "integer" - } - } - }, - "lifecycle-manager_common-http_response": { - "oneOf": [ - { - "description": "A success response from an API method", - "type": "object", - "additionalProperties": false, - "required": ["message", "data", "metadata"], - "properties": { - "message": { - "description": "A human-readable message summarizing the result of the operation", - "type": "string", - "examples": [ - "Successfully created the requested item", - "Successfully imported 3 of 4 documents", - "Successfully retrieved search results" - ] - }, - "data": { - "const": "null", - "description": "Any successfully retrieved information related to the request." - }, - "metadata": { - "description": "Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.", - "type": "object", - "additionalProperties": true - } - } - }, - { - "description": "A failure response from an API method", - "type": "object", - "additionalProperties": false, - "required": ["message", "data", "metadata"], - "properties": { - "message": { - "description": "A human-readable message summarizing the result of the operation", - "type": "string", - "examples": [ - "A server error occurred while processing this request" - ] - }, - "data": { - "const": "null", - "description": "Any successfully retrieved information related to the request. For error responses, this is always 'null'." - }, - "metadata": { - "description": "Any structured, wordy or machine-readable information related to the result of the operation. For error responses, this will always at least contain an 'errors' array, even if it is empty.", - "type": "object", - "properties": { - "errors": { - "type": "array" - } - }, - "additionalProperties": true - } - } - } - ] - }, - "lifecycle-manager_common_name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "lifecycle-manager_common_ObjectIdLikeString": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "lifecycle-manager_common_ObjectId": { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - }, - "lifecycle-manager_instance-group-create": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Resource Instance Group Create", - "description": "The format of accepted input for the creation of a Resource Instance Group document.", - "type": "object", - "allOf": [ - { - "propertyNames": { - "enum": [ - "name", - "description", - "modelId", - "type", - "lastAction", - "instances", - "filter" - ] - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": ["Some helpful information about the document"] - }, - "modelId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "oneOf": [ - { - "type": "object", - "not": { - "required": ["filter"] - }, - "properties": { - "type": { - "const": "manual" - }, - "instances": { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "type": "object", - "not": { - "required": ["instances"] - }, - "properties": { - "type": { - "const": "dynamic" - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "lastAction": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - }, - "created": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "updated": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - } - } - } - } - } - ] - } - ] - }, - { - "required": ["name", "modelId"] - } - ] - }, - "lifecycle-manager_instance-group-http": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Resource Instance Group Document", - "description": "A Resource Instance Group document in HTTP response format.", - "type": "object", - "allOf": [ - { - "propertyNames": { - "anyOf": [ - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["_id"] - }, - { - "enum": [ - "name", - "description", - "modelId", - "type", - "lastAction", - "instances", - "filter" - ] - } - ] - } - }, - { - "type": "object", - "required": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "object", - "properties": { - "firstname": { - "type": "string" - }, - "provenance": { - "type": "string" - }, - "username": { - "type": "string" - }, - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "object", - "properties": { - "firstname": { - "type": "string" - }, - "provenance": { - "type": "string" - }, - "username": { - "type": "string" - }, - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "required": ["_id"] - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "allOf": [ - { - "type": "object", - "required": [ - "name", - "description", - "modelId", - "type", - "lastAction" - ] - }, - { - "oneOf": [ - { - "type": "object", - "required": ["instances"] - }, - { - "type": "object", - "required": ["filter"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": ["Some helpful information about the document"] - }, - "modelId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "oneOf": [ - { - "type": "object", - "not": { - "required": ["filter"] - }, - "properties": { - "type": { - "const": "manual" - }, - "instances": { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "type": "object", - "not": { - "required": ["instances"] - }, - "properties": { - "type": { - "const": "dynamic" - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "lastAction": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - }, - "created": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "updated": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - } - } - } - } - } - ] - } - ] - }, - { - "type": "object", - "properties": { - "lastAction": { - "description": "The last action that was run against this document", - "type": "object", - "additionalProperties": false, - "required": ["_id", "executionId", "name", "type", "status"], - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "executionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": [ - "running", - "error", - "complete", - "canceled", - "paused" - ] - } - } - } - } - } - ] - }, - "lifecycle-manager_instance-group-search-params": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Resource Instance Group Search Parameters", - "description": "Search Parameters supported on the Resource Instance Group collection.", - "type": "object", - "allOf": [ - { - "type": "object", - "properties": { - "skip": { - "description": "This parameter specifies where to start the returned page of search results.", - "type": "string" - }, - "limit": { - "description": "This parameter specifies how many items to return in the search results.", - "type": "string" - } - } - }, - { - "type": "object", - "properties": { - "sort": { - "description": "This parameter specifies the field to sort the search results over.", - "type": "string", - "examples": ["name", "created"] - }, - "order": { - "description": "This parameter specifies the direction to sort the search results over.", - "enum": ["asc", "desc"] - } - } - }, - { - "properties": { - "equals": { - "type": "object", - "properties": { - "modelName": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "type": { - "enum": ["manual", "dynamic"] - }, - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "modelId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "createdBy": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "in": { - "allOf": [ - { - "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", - "type": "object", - "examples": [ - { - "stateId": "1234,53fe,0000" - }, - { - "name": "name1,name2,name3" - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "array", - "items": { - "enum": ["manual", "dynamic"] - } - }, - "lastAction": { - "type": "object", - "properties": { - "type": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - } - } - } - } - } - ] - }, - "starts-with": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - } - } - }, - "lt": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "lte": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "gt": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "gte": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "dereference": { - "description": "Comma-separated list of foreign key field types to dereference", - "const": "accounts" - } - } - } - ] - }, - "lifecycle-manager_instance-group-update": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Resource Instance Group Update", - "description": "The format of accepted input for updating a Resource Instance Group document.", - "type": "object", - "allOf": [ - { - "propertyNames": { - "allOf": [ - { - "enum": [ - "name", - "description", - "modelId", - "type", - "lastAction", - "instances", - "filter" - ] - }, - { - "enum": ["instancesToAdd", "instancesToRemove"] - } - ] - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": ["Some helpful information about the document"] - }, - "modelId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "oneOf": [ - { - "type": "object", - "not": { - "required": ["filter"] - }, - "properties": { - "type": { - "const": "manual" - }, - "instances": { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "type": "object", - "not": { - "required": ["instances"] - }, - "properties": { - "type": { - "const": "dynamic" - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "lastAction": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - }, - "created": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "updated": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - } - } - } - } - } - ] - } - ] - }, - { - "properties": { - "instancesToAdd": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - } - ] - } - }, - "instancesToRemove": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - } - ] - } - } - } - } - ] - }, - "lifecycle-manager_resource-action-execution-http": { - "oneOf": [ - { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "modelId", - "modelName", - "instanceId", - "instanceName", - "actionId", - "actionName", - "jobId", - "startTime", - "endTime", - "progress", - "status", - "errors", - "initiator", - "initiatorName", - "initialInstanceData", - "finalInstanceData" - ], - "properties": { - "_id": {}, - "modelId": {}, - "modelName": { - "description": "The name of the model as it was when the action was run", - "type": "string" - }, - "executionType": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - }, - "instanceId": {}, - "instanceName": { - "description": "The name of the instance as it was when the action was run", - "type": "string" - }, - "actionId": { - "description": "Identifier of the action that was run" - }, - "actionName": { - "description": "The name of the action as it was when the action was run", - "type": "string" - }, - "actionType": { - "description": "The type of the action" - }, - "jobId": { - "description": "Identifier of the job associated with the action", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "progress": { - "description": "A sequence of key points in the action describing its overall progress", - "type": "object", - "patternProperties": { - ".*": { - "description": "A record indicating a progress point in the flow of the action", - "type": "object", - "additionalProperties": false, - "required": [ - "progressType", - "status", - "error", - "_id", - "componentName", - "componentId" - ], - "properties": { - "_id": { - "description": "Uniquely identifies the progress point within the overall sequence", - "type": "string" - }, - "componentId": { - "description": "The id of the component related to the step", - "type": "string" - }, - "componentName": { - "description": "The name of the component related to the step", - "type": "string" - }, - "progressType": { - "description": "Designates what type of progress point this object describes", - "const": "resource:action" - }, - "error": { - "description": "Records any errors directly related to the components in the progress item", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "status": { - "description": "Designates the status of the progress item", - "type": "string", - "enum": ["pending", "complete", "error"] - } - } - } - } - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": ["running", "error", "complete", "canceled", "paused"] - }, - "errors": { - "description": "A list of any errors which occurred while the action was running", - "type": "array", - "items": { - "description": "A record of an error which occurred while the action was running", - "type": "object", - "properties": { - "message": { - "description": "A human-readable message summarizing the issue", - "type": "string" - }, - "origin": { - "description": "Designates where the error came from", - "type": "string", - "enum": [ - "preTransformation", - "workflow", - "postTransformation", - "finishAction", - "system" - ] - }, - "timestamp": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "metadata": { - "description": "Additional properties that help describe the issue" - }, - "stepId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - } - }, - "initiator": {}, - "initiatorName": { - "description": "The name of the user or automation trigger that initiated the action", - "type": "string" - }, - "initialInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - }, - "finalInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - } - }, - { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "modelId", - "modelName", - "instanceId", - "instanceName", - "actionId", - "actionName", - "parentActionExecutionId", - "jobId", - "startTime", - "endTime", - "progress", - "status", - "errors", - "initiator", - "initiatorName", - "initialInstanceData", - "finalInstanceData" - ], - "properties": { - "_id": {}, - "modelId": {}, - "modelName": { - "description": "The name of the model as it was when the action was run", - "type": "string" - }, - "executionType": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - }, - "instanceId": {}, - "instanceName": { - "description": "The name of the instance as it was when the action was run", - "type": "string" - }, - "actionId": { - "description": "Identifier of the action that was run" - }, - "actionName": { - "description": "The name of the action as it was when the action was run", - "type": "string" - }, - "actionType": { - "description": "The type of the action" - }, - "parentActionExecutionId": { - "description": "Identifier of the job associated with the action" - }, - "groupId": { - "description": "Identifier of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "groupName": { - "description": "The name of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "jobId": { - "description": "Identifier of the job associated with the action", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "progress": { - "description": "A sequence of key points in the action describing its overall progress", - "type": "object", - "patternProperties": { - ".*": { - "description": "A record indicating a progress point in the flow of the action", - "type": "object", - "additionalProperties": false, - "required": [ - "progressType", - "status", - "error", - "_id", - "componentName", - "componentId" - ], - "properties": { - "_id": { - "description": "Uniquely identifies the progress point within the overall sequence", - "type": "string" - }, - "componentId": { - "description": "The id of the component related to the step", - "type": "string" - }, - "componentName": { - "description": "The name of the component related to the step", - "type": "string" - }, - "progressType": { - "description": "Designates what type of progress point this object describes", - "const": "resource:action" - }, - "error": { - "description": "Records any errors directly related to the components in the progress item", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "status": { - "description": "Designates the status of the progress item", - "type": "string", - "enum": ["pending", "complete", "error"] - } - } - } - } - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": ["running", "error", "complete", "canceled", "paused"] - }, - "errors": { - "description": "A list of any errors which occurred while the action was running", - "type": "array", - "items": { - "description": "A record of an error which occurred while the action was running", - "type": "object", - "properties": { - "message": { - "description": "A human-readable message summarizing the issue", - "type": "string" - }, - "origin": { - "description": "Designates where the error came from", - "type": "string", - "enum": [ - "preTransformation", - "workflow", - "postTransformation", - "finishAction", - "system" - ] - }, - "timestamp": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "metadata": { - "description": "Additional properties that help describe the issue" - }, - "stepId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - } - }, - "initiator": {}, - "initiatorName": { - "description": "The name of the user or automation trigger that initiated the action", - "type": "string" - }, - "initialInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - }, - "finalInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - } - }, - { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "modelId", - "modelName", - "instanceIds", - "childStatuses", - "actionId", - "actionName", - "jobId", - "startTime", - "endTime", - "progress", - "status", - "errors", - "initiator", - "initiatorName" - ], - "properties": { - "_id": {}, - "modelId": {}, - "modelName": { - "description": "The name of the model as it was when the action was run", - "type": "string" - }, - "executionType": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - }, - "instanceIds": { - "description": "The IDs of the instances that are being acted upon", - "type": "array", - "items": {} - }, - "childStatuses": { - "description": "An object mapping the current status of child action executions", - "type": "object" - }, - "actionId": { - "description": "Identifier of the action that was run" - }, - "actionName": { - "description": "The name of the action as it was when the action was run", - "type": "string" - }, - "actionType": { - "description": "The type of the action" - }, - "groupId": { - "description": "Identifier of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "groupName": { - "description": "The name of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "jobId": { - "description": "Identifier of the job associated with the action", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "progress": { - "description": "A sequence of key points in the action describing its overall progress", - "type": "object", - "patternProperties": { - ".*": { - "description": "A record indicating a progress point in the flow of the action", - "type": "object", - "additionalProperties": false, - "required": [ - "progressType", - "status", - "error", - "_id", - "componentName", - "componentId" - ], - "properties": { - "_id": { - "description": "Uniquely identifies the progress point within the overall sequence", - "type": "string" - }, - "componentId": { - "description": "The id of the component related to the step", - "type": "string" - }, - "componentName": { - "description": "The name of the component related to the step", - "type": "string" - }, - "progressType": { - "description": "Designates what type of progress point this object describes", - "const": "resource:action" - }, - "error": { - "description": "Records any errors directly related to the components in the progress item", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "status": { - "description": "Designates the status of the progress item", - "type": "string", - "enum": ["pending", "complete", "error"] - } - } - } - } - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": ["running", "error", "complete", "canceled", "paused"] - }, - "errors": { - "description": "A list of any errors which occurred while the action was running", - "type": "array", - "items": { - "description": "A record of an error which occurred while the action was running", - "type": "object", - "properties": { - "message": { - "description": "A human-readable message summarizing the issue", - "type": "string" - }, - "origin": { - "description": "Designates where the error came from", - "type": "string", - "enum": [ - "preTransformation", - "workflow", - "postTransformation", - "finishAction", - "system" - ] - }, - "timestamp": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "metadata": { - "description": "Additional properties that help describe the issue" - }, - "stepId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - } - }, - "initiator": { - "oneOf": [ - { - "const": "Pronghorn" - }, - {} - ] - }, - "initiatorName": { - "type": "string" - }, - "initialInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - }, - "finalInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - } - } - ] - }, - "lifecycle-manager_resource-action-execution-search-params": { - "description": "Search parameters for resource action executions", - "type": "object", - "additionalProperties": false, - "required": [], - "allOf": [ - { - "type": "object", - "properties": { - "skip": { - "description": "This parameter specifies where to start the returned page of search results.", - "type": "string" - }, - "limit": { - "description": "This parameter specifies how many items to return in the search results.", - "type": "string" - } - } - }, - { - "type": "object", - "properties": { - "sort": { - "description": "This parameter specifies the field to sort the search results over.", - "type": "string", - "examples": ["name", "created"] - }, - "order": { - "description": "This parameter specifies the direction to sort the search results over.", - "enum": ["asc", "desc"] - } - } - }, - { - "type": "object", - "properties": { - "equals": { - "type": "object", - "properties": { - "_id": {}, - "modelId": {}, - "modelName": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "instanceId": {}, - "instanceName": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "groupId": {}, - "groupName": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "actionId": { - "description": "The identifier of an action" - }, - "actionName": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "jobId": {}, - "executionType": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - }, - "startTime": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "endTime": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": [ - "running", - "error", - "complete", - "canceled", - "paused" - ] - }, - "initiator": {}, - "parentActionExecutionId": {} - } - }, - "in": { - "allOf": [ - { - "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", - "type": "object", - "examples": [ - { - "stateId": "1234,53fe,0000" - }, - { - "name": "name1,name2,name3" - } - ] - }, - { - "type": "object", - "properties": { - "modelId": { - "description": "A comma-delineated list of model ids to search for", - "type": "array", - "items": {} - }, - "gruopId": { - "description": "A comma-delineated list of group ids to search for", - "type": "array", - "items": {} - }, - "status": { - "description": "A comma-delineated list of statuses to search for", - "type": "array", - "items": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": [ - "running", - "error", - "complete", - "canceled", - "paused" - ] - } - }, - "executionType": { - "description": "A comma-delineated list of execution types to search for", - "type": "array", - "items": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - } - } - } - } - ] - }, - "starts-with": { - "type": "object", - "properties": { - "modelName": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "groupName": { - "description": "The name of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "instanceName": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "actionName": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "initiatorName": { - "type": "string" - } - } - }, - "lt": { - "type": "object", - "properties": { - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - } - } - }, - "lte": { - "type": "object", - "properties": { - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - } - } - }, - "gt": { - "type": "object", - "properties": { - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - } - } - }, - "gte": { - "type": "object", - "properties": { - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - } - } - }, - "include": { - "type": "array", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - }, - "lifecycle-manager_resource-instance-common_name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "lifecycle-manager_resource-instance-common_description": { - "type": "string", - "description": "Free-form text describing the resource instance", - "default": "", - "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] - }, - "lifecycle-manager_resource-instance-export": { - "type": "object", - "additionalProperties": false, - "required": [ - "name", - "description", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy", - "instanceData" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource instance", - "default": "", - "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] - }, - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource instance" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource instance" - }, - "instanceData": { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - "lifecycle-manager_resource-instance-http": { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "name", - "description", - "modelId", - "instanceData", - "lastAction", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource instance", - "default": "", - "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] - }, - "modelId": {}, - "instanceData": { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "lastAction": { - "description": "The last action that was run on this instance", - "type": "object", - "additionalProperties": false, - "required": ["_id", "executionId", "name", "type", "status"], - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "executionId": {}, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": ["running", "error", "complete", "canceled", "paused"] - } - } - }, - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource instance" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource instance" - }, - "instanceGroups": { - "description": "The groups that this resource instance is a member of", - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - } - } - } - } - } - }, - "lifecycle-manager_resource-instance-search-params": { - "type": "object", - "additionalProperties": false, - "required": [], - "allOf": [ - { - "type": "object", - "properties": { - "skip": { - "description": "This parameter specifies where to start the returned page of search results.", - "type": "string" - }, - "limit": { - "description": "This parameter specifies how many items to return in the search results.", - "type": "string" - } - } - }, - { - "type": "object", - "properties": { - "sort": { - "description": "This parameter specifies the field to sort the search results over.", - "type": "string", - "examples": ["name", "created"] - }, - "order": { - "description": "This parameter specifies the direction to sort the search results over.", - "enum": ["asc", "desc"] - } - } - }, - { - "properties": { - "equals": { - "type": "object", - "properties": { - "modelName": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "stateName": { - "description": "The name of the current state of the resource instance", - "type": "string" - }, - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "modelId": {}, - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "createdBy": {}, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - }, - "lastUpdatedBy": {} - } - }, - "in": { - "allOf": [ - { - "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", - "type": "object", - "examples": [ - { - "stateId": "1234,53fe,0000" - }, - { - "name": "name1,name2,name3" - } - ] - }, - { - "type": "object", - "properties": { - "lastAction": { - "type": "object", - "properties": { - "type": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - } - } - } - } - } - ] - }, - "include-deleted": { - "type": "string", - "default": "false", - "enum": ["true", "false"] - }, - "starts-with": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - } - } - }, - "group": { - "type": "string", - "description": "An ID or name of an instance group to filter by", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "instanceGroups": { - "type": "string", - "default": "false", - "enum": ["true", "false"] - }, - "lt": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - } - } - }, - "lte": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - } - } - }, - "gt": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - } - } - }, - "gte": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - } - } - }, - "include": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "_id", - "name", - "description", - "modelId", - "instanceData", - "lastAction", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ] - } - }, - "exclude": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "_id", - "name", - "description", - "modelId", - "instanceData", - "lastAction", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ] - } - }, - "dereference": { - "description": "Comma-separated list of foreign key field types to dereference", - "const": "accounts" - } - } - } - ] - }, - "lifecycle-manager_resource-model-common_name": { - "type": "string", - "description": "The name of the resource model", - "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] - }, - "lifecycle-manager_resource-model-common_action-identifier": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - }, - "lifecycle-manager_resource-model-common_action": { - "type": "object", - "required": [ - "_id", - "name", - "workflow", - "preWorkflowJst", - "postWorkflowJst", - "type" - ], - "additionalProperties": false, - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - }, - "lifecycle-manager_resource-model-common_actions": { - "type": "array", - "items": { - "type": "object", - "required": [ - "_id", - "name", - "workflow", - "preWorkflowJst", - "postWorkflowJst", - "type" - ], - "additionalProperties": false, - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - } - }, - "lifecycle-manager_resource-model-create-data": { - "type": "object", - "additionalProperties": false, - "required": ["name"], - "properties": { - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource model", - "default": "", - "examples": [ - "This resource model represents something we use on a day-to-day basis.", - "We use this to model one of the devices in our system.", - "This model tracks one of the elements of our cloud infrastructure." - ] - }, - "schema": { - "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "required": [ - "name", - "workflow", - "preWorkflowJst", - "postWorkflowJst", - "type" - ], - "additionalProperties": false, - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The _id of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "description": "The UUIDv4 identifying a workflow" - } - ] - } - } - } - } - } - }, - "lifecycle-manager_resource-model-export": { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "name", - "description", - "schema", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource model", - "default": "", - "examples": [ - "This resource model represents something we use on a day-to-day basis.", - "We use this to model one of the devices in our system.", - "This model tracks one of the elements of our cloud infrastructure." - ] - }, - "schema": { - "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - } - }, - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource model" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource model" - } - } - }, - "lifecycle-manager_resource-model-http": { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "name", - "description", - "schema", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource model", - "default": "", - "examples": [ - "This resource model represents something we use on a day-to-day basis.", - "We use this to model one of the devices in our system.", - "This model tracks one of the elements of our cloud infrastructure." - ] - }, - "schema": { - "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "required": [ - "_id", - "name", - "workflow", - "preWorkflowJst", - "postWorkflowJst", - "type" - ], - "additionalProperties": false, - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The _id of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "description": "The UUIDv4 identifying a workflow" - } - ] - }, - "inputSchema": { - "description": "The schema describing inputs to this action", - "type": "object" - }, - "outputSchema": { - "description": "The schema describing inputs to this action", - "type": "object" - } - } - } - }, - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource model" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource model" - } - } - }, - "lifecycle-manager_resource-model-import": { - "type": "object", - "additionalProperties": false, - "required": ["model"], - "properties": { - "model": { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "name", - "description", - "schema", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource model", - "default": "", - "examples": [ - "This resource model represents something we use on a day-to-day basis.", - "We use this to model one of the devices in our system.", - "This model tracks one of the elements of our cloud infrastructure." - ] - }, - "schema": { - "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - } - }, - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource model" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource model" - } - }, - "definitions": { - "action-workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "action": { - "type": "object", - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - } - } - } - }, - "overwrite": { - "type": "boolean" - } - } - }, - "lifecycle-manager_resource-model-search-params": { - "type": "object", - "additionalProperties": false, - "required": [], - "allOf": [ - { - "type": "object", - "properties": { - "skip": { - "description": "This parameter specifies where to start the returned page of search results.", - "type": "string" - }, - "limit": { - "description": "This parameter specifies how many items to return in the search results.", - "type": "string" - } - } - }, - { - "type": "object", - "properties": { - "sort": { - "description": "This parameter specifies the field to sort the search results over.", - "type": "string", - "examples": ["name", "created"] - }, - "order": { - "description": "This parameter specifies the direction to sort the search results over.", - "enum": ["asc", "desc"] - } - } - }, - { - "type": "object", - "properties": { - "equals": { - "type": "object", - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "starts-with": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - } - } - }, - "contains": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - } - } - }, - "lt": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "lte": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "gt": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "gte": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "dereference": { - "description": "Comma-separated list of field types to dereference", - "type": "string" - } - } - } - ] - } - }, - "securitySchemes": { - "OAuth" : { - "type" : "oauth2", - "flows" : { - "clientCredentials" : { - "tokenUrl" : "https://platform/oauth/token", - "refreshUrl" : "", - "scopes" : {} - } - } - } - } - } -} diff --git a/Itential/Platform/OpenAPISpecs/platform6.json b/Itential/Platform/OpenAPISpecs/platform6.json deleted file mode 100644 index bed0786..0000000 --- a/Itential/Platform/OpenAPISpecs/platform6.json +++ /dev/null @@ -1,79608 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "Platform 6", - "description": "Platform 6 REST API for Application Integration.", - "version": "1.0.0", - "x-logo": { - "url": "https://www.itential.com/wp-content/uploads/2022/08/Color-Variation-White.png", - "backgroundColor": "#FFFFFF", - "altText": "Itential logo" - } - }, - "servers": [ - { - "url": "{protocol}://{server}:{port}", - "variables": { - "protocol": { - "default": "http", - "description": "The server protocol" - }, - "server": { - "default": "localhost", - "description": "The server IP or DNS" - }, - "port": { - "default": "3000", - "description": "The server port" - } - } - } - ], - "x-tagGroups": [ - { - "name": "Home", - "tags": ["home-about", "home-baseline"] - }, - { - "name": "Authentication", - "tags": ["auth-reqs", "auth-basic", "auth-query-token", "auth-client"] - }, - { - "name": "Getting Started", - "tags": [ - "example-whoami-basic", - "example-whoami-query-token", - "example-whoami-client-bearer-token" - ] - }, - { - "name": "API Reference", - "tags": [ - "api-reference", - "adapter-models", - "adapters", - "ag-manager", - "applications", - "authentication", - "authorization", - "automation-studio", - "configuration_manager", - "customization", - "device-counts", - "external-links", - "git", - "group-mappings", - "health", - "help", - "indexes", - "integration-models", - "integrations", - "json-forms", - "lifecycle-manager", - "mop", - "oauth", - "operations-manager", - "profiles", - "schema", - "search", - "sso", - "tags", - "template_builder", - "transformations", - "user", - "workflow_builder", - "workflow_engine" - ] - } - ], - "tags": [ - { - "name": "home-about", - "x-displayName": "About", - "description": "The Itential REST API uses OpenAPI 3.1.0 specifications and supports Basic Authentication and OAuth 2.0 to authenticate requests. This reference library documents available APIs for the Platform 6, including HTTP response codes to indicate success or failure of an API request. Platform 6 REST APIs also use standard verbs to perform CRUD operations. For product documentation, visit [Itential Documentation & Guides](https://docs.itential.com/v1/en).\n
" - }, - { - "name": "home-baseline", - "x-displayName": "Ports and Base Path", - "description": "Default HTTP port is `3000`. Default HTTPS port is `3443`. Both IPv6 and IPv4 are supported. Default host is `127.0.0.1`. The basePath is `/`.\n
\n" - }, - { - "name": "auth-reqs", - "x-displayName": "Authentication", - "description": "API requests without authentication will fail. Available authorizations include: `BasicAuth` (username/password), `CookieAuth`(token/cookie-based) and `QueryAuth` (token/query-based).\n
\n" - }, - { - "name": "auth-basic", - "x-displayName": "Basic Auth", - "description": "

This API uses Basic Authentication for securing its endpoints.

\n\n

How to Use Basic Authentication

\n

Using this authentication strategy, you need to provide your credentials in the HTTP request headers. The credentials should be sent as a base64 encoded string of username:password.

\n\n

Example: Using curl for Basic Authentication

\n
\n curl -u username:password -X GET \"https://localhost:3443\"\n
\n\n

In this example, -u is the flag used by curl to specify the username and password. Replace username and password with your actual credentials.

\n\n

HTTP Request Headers

\n

The Basic Authentication credentials are sent in the Authorization header. Here's what it looks like:

\n
\n Authorization: Basic base64(username:password)\n
\n\n

Base64 Encoding

\n

The username:password string needs to be base64 encoded before it is sent in the header. For example, if your username is user and your password is pass, the string to encode is user:pass. The base64 encoded result would look something like this:

\n
\n Authorization: Basic dXNlcjpwYXNz\n
\n" - }, - { - "name": "auth-query-token", - "x-displayName": "Query Token", - "description": "

Authentication

\n

Using this authentication strategy, you need to authenticate and obtain a token by making a POST request to the /login endpoint. The response token will be used in the token query parameter for subsequent requests.

\n\n

How to Request a Token

\n

To obtain an authentication token, send a POST request to the /login endpoint with the following JSON payload:

\n\n
\n \n {\n \"user\": {\n \"username\": \"admin\",\n \"password\": \"admin\"\n }\n }\n \n
\n\n

Example: Using curl to Request a Token

\n
\n curl -X POST \"https://localhost:3443/login\" -H \"Content-Type: application/json\" -d '{\"user\": {\"username\": \"admin\", \"password\": \"admin\"}}'\n
\n\n

In this example, the -d flag is used by curl to send the JSON body with the request.

\n\n

Response

\n

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

\n\n
\n \n your-auth-token-here\n \n
\n\n

Using the Token in Subsequent Requests

\n

Once you have the token, include it in the query string of your requests as follows:

\n\n
\n ?token=your-auth-token-here\n
\n" - }, - { - "name": "auth-client", - "x-displayName": "Client Auth", - "description": "

Authentication

\n

Using this authentication strategy, you need to authenticate and obtain a Bearer token by making a POST request to the /oauth/token endpoint. The response access_token will be used as temporary credentials that the client will set in the Authorization header. Here's what it looks like:

\n
\n Authorization: Basic access_token\n
\n\n.

\n\n

How to Request a Token

\n

To obtain an authentication token, send a POST request to the /oauth/token endpoint. You'll need to send the data as application/x-www-form-urlencoded with the following payload:

\n\n
\n client_id=your-client-id&client_secret=your-client-secret&grant_type=client_credentials\n
\n\n

Example: Using curl to Request a Bearer Token

\n
\n curl -X POST \"https://localhost:3443/oauth/token\" -H \"Content-Type: accept: application/json\" -H \"Content-Type: application/x-www-form-urlencoded\" -d 'client_id=123abccc123a123a12ab1ab1&client_secret=a123a123-a1a1-1a1a-a123-123a12abc1a1&grant_type=client_credentials'\n
\n\n

In this example, the -d flag is used by curl to send the data with the request.

\n\n

Response

\n

If the login is successful, the API will return the authentication token. The token can be used in the token query parameter for subsequent requests:

\n\n
\n\n{\n\"access_token\": \"falksjflkasdjflkasdjfklajsdflj.eyJwcmluY2lwYWxJZCI6IjY2OWU1ZGNjOTE1ZDUxMWEzMmJmMGNhNCIsImV4cCI6MTcyMTY1OTQ4MDkwMiwiaWF0IjoxNzIxNjU1ODgwfQ.7jrB2mC9aqSdPdUvz7D-u9HghRFtnpFbYdaBH54kNZc\",\"token_type\": \"bearer\",\"expires_in\": 3600}\n \n
\n\n

Using the Bearer Token in Subsequent Requests

\n

Once you have the Bearer token, use it as your Authorization header. Here's what it should look like:

\n\n
\n Authorization: Bearer your-access_token-here\n
\n" - }, - { - "name": "example-whoami-basic", - "x-displayName": "Example (whoami) - Basic Auth", - "description": "To test the API using Basic Authentication, you can use the following\n`curl` command. Replace `username` and `password` with your actual\ncredentials.\n\nNote: Basic Auth is only available over SSL.\n\n\n
\n curl -u username:password -X GET \"https://localhost:3443/whoami\"\n
\n\nThis command sends a GET request to the specified resource, using the\nprovided username and password for authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" - }, - { - "name": "example-whoami-query-token", - "x-displayName": "Example (whoami) - Query Token", - "description": "To test the API using the Query Token Authentication, you can use the following\n`curl` command. Replace `your-auth-token-here` with your actual\ntoken that you received using `/login`.\n\n\n
\n curl -X GET \"https://localhost:3443/whoami?token=your-auth-token-here\"\n
\n\nThis command sends a GET request to the specified resource, using the\nQuery Token authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" - }, - { - "name": "example-whoami-client-bearer-token", - "x-displayName": "Example (whoami) - Client Bearer Token", - "description": "To test the API using the Client Authentication, you can use the following\n`curl` command. Replace `your-access_token-here` with your actual\nBearer token that you received using `/oauth/token`.\n\n\n
\n curl -X GET \"https://localhost:3443/whoami\" -H \"Authorization: Bearer your-access_token-here\" \n
\n\nThis command sends a GET request to the specified resource, using the\nClient authentication. Running the whoami operation will confirm that you can reach the IAP server's API and it will return access associated to your user.\n\n
\n" - }, - { - "name": "adapter-models", - "x-displayName": "Adapter Models" - }, - { - "name": "adapters", - "x-displayName": "Adapters" - }, - { - "name": "ag-manager", - "x-displayName": "Automation Gateway" - }, - { - "name": "applications", - "x-displayName": "Applications" - }, - { - "name": "authentication", - "x-displayName": "Authentication" - }, - { - "name": "authorization", - "x-displayName": "Authorization" - }, - { - "name": "automation-studio", - "x-displayName": "Automation Studio", - "description": "A suite of tools for designing workflows, templates, and forms." - }, - { - "name": "configuration_manager", - "description": "Unified manager application for devices and configurations" - }, - { - "name": "configuration_manager", - "x-displayName": "Configuration Manager" - }, - { - "name": "customization", - "x-displayName": "Customization" - }, - { - "name": "device-counts", - "x-displayName": "Device Counts" - }, - { - "name": "external-links", - "x-displayName": "External Links" - }, - { - "name": "formbuilder", - "description": "API to generate dynamic forms" - }, - { - "name": "git", - "x-displayName": "Git" - }, - { - "name": "group-mappings", - "x-displayName": "Group Mappings" - }, - { - "name": "health", - "x-displayName": "Health" - }, - { - "name": "help", - "x-displayName": "Help", - "description": "Documentation Help" - }, - { - "name": "indexes", - "x-displayName": "Indexes" - }, - { - "name": "integration-models", - "x-displayName": "Integration Models" - }, - { - "name": "integrations", - "x-displayName": "Integrations" - }, - { - "name": "json-forms", - "x-displayName": "JSON Forms", - "description": "An application to create, edit, and publish forms based on JSON documents." - }, - { - "name": "lifecycle-manager", - "x-displayName": "Lifecycle Manager" - }, - { - "name": "mop", - "x-displayName": "Command Templates (MOP)" - }, - { - "name": "oauth", - "x-displayName": "OAuth" - }, - { - "name": "operations-manager", - "x-displayName": "Operations Manager" - }, - { - "name": "prebuilts", - "description": "Pre-Builts API" - }, - { - "name": "prebuilts-repository", - "description": "Pre-Builts Repository API" - }, - { - "name": "profiles", - "x-displayName": "Profiles" - }, - { - "name": "prometheus_metrics", - "x-displayName": "Prometheus Metrics" - }, - { - "name": "schema", - "x-displayName": "Schema" - }, - { - "name": "search", - "x-displayName": "Search" - }, - { - "name": "sso", - "x-displayName": "Single Sign On" - }, - { - "name": "tags", - "x-displayName": "Tags" - }, - { - "name": "template_builder", - "x-displayName": "Template Builder" - }, - { - "name": "transformations", - "x-displayName": "Transformations" - }, - { - "name": "user", - "x-displayName": "User" - }, - { - "name": "workflow_builder", - "x-displayName": "Workflow Builder" - }, - { - "name": "workflow_engine", - "x-displayName": "Workflow Engine" - } - ], - "paths": { - "/adapters": { - "post": { - "summary": "Create a new adapter.", - "description": "Create a new adapter in IAP.", - "tags": ["adapters"], - "parameters": [], - "operationId": "Adapters.createAdapter", - "responses": { - "200": { - "description": "The result of the adapter creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin"], - "CookieAuth": ["Adapters.admin"], - "BasicAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "model": { - "$ref": "#/components/schemas/iap_services-schema_model" - }, - "name": { - "$ref": "#/components/schemas/iap_services-schema_name" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "title": "id", - "description": "The id for the service", - "const": { - "$data": "2/name" - }, - "examples": ["Local AAA"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of an adapter", - "examples": ["local_aaa", "Redis", "Email"] - }, - "properties": { - "type": "object", - "properties": {} - }, - "brokers": { - "type": "array", - "description": "Brokers which utilize this service", - "items": { - "type": "string", - "description": "Name of the broker", - "examples": ["aaa"] - } - }, - "groups": { - "type": "array", - "description": "Groups which can use this service", - "items": { - "type": "string", - "description": "Name of the group", - "examples": ["pronghorn_admin"] - } - } - }, - "required": ["id", "type"] - } - }, - "required": ["name", "type", "properties"] - } - } - } - } - } - } - }, - "get": { - "summary": "Get all adapters.", - "description": "Get all adapters in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "skipActiveSync", - "in": "query", - "description": "skipActiveSync", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - } - ], - "operationId": "Adapters.getAdapters", - "responses": { - "200": { - "description": "Contains an array of adapters and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin", "Adapters.apiread"], - "CookieAuth": ["Adapters.admin", "Adapters.apiread"], - "BasicAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": false - } - }, - "/adapters/import": { - "post": { - "summary": "Import a new adapter.", - "description": "Import a new adapter in IAP.", - "tags": ["adapters"], - "parameters": [], - "operationId": "Adapters.importAdapter", - "responses": { - "200": { - "description": "The result of the adapter import process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin"], - "CookieAuth": ["Adapters.admin"], - "BasicAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "model": { - "$ref": "#/components/schemas/iap_services-schema_model" - }, - "name": { - "$ref": "#/components/schemas/iap_services-schema_name" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "migrationVersion": { - "type": "integer", - "minimum": 0 - }, - "properties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "title": "id", - "description": "The id for the service", - "const": { - "$data": "2/name" - }, - "examples": ["Local AAA"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of an adapter", - "examples": ["local_aaa", "Redis", "Email"] - }, - "properties": { - "type": "object", - "properties": {} - }, - "brokers": { - "type": "array", - "description": "Brokers which utilize this service", - "items": { - "type": "string", - "description": "Name of the broker", - "examples": ["aaa"] - } - }, - "groups": { - "type": "array", - "description": "Groups which can use this service", - "items": { - "type": "string", - "description": "Name of the group", - "examples": ["pronghorn_admin"] - } - } - }, - "required": ["id", "type"] - } - }, - "required": ["name", "type", "properties"] - } - } - } - } - } - } - } - }, - "/adapters/{name}": { - "delete": { - "summary": "Delete an adapter.", - "description": "Delete an adapter from IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.deleteAdapter", - "responses": { - "200": { - "description": "The output of the adapter deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin"], - "CookieAuth": ["Adapters.admin"], - "BasicAuth": ["Adapters.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a single adapter.", - "description": "Get a single adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.getAdapter", - "responses": { - "200": { - "description": "Contains the data of a single adapter.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin", "Adapters.apiread"], - "CookieAuth": ["Adapters.admin", "Adapters.apiread"], - "BasicAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an adapter.", - "description": "Update an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.updateAdapter", - "responses": { - "200": { - "description": "The output of the adapter update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin"], - "CookieAuth": ["Adapters.admin"], - "BasicAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "$ref": "#/components/schemas/iap_services-schema_properties" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/adapters/{name}/export": { - "get": { - "summary": "Export a single adapter.", - "description": "Export a single adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.exportAdapter", - "responses": { - "200": { - "description": "Contains the data of a single adapter.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin", "Adapters.apiread"], - "CookieAuth": ["Adapters.admin", "Adapters.apiread"], - "BasicAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": false - } - }, - "/adapters/{name}/changelogs": { - "get": { - "summary": "Get the list of changelogs.", - "description": "Get the list of changelogs for a specific adapter.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["WorkFlowEngine", "MOP"] - } - }, - { - "name": "release", - "in": "query", - "description": "release", - "required": false, - "schema": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - } - } - ], - "operationId": "Adapters.getAdapterChangelogs", - "responses": { - "200": { - "description": "The list of changelogs available for the requested adapter.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "string", - "examples": [ - { - "2020.1.1": "Changelog for 2020.1" - } - ], - "pattern": "^[0-9]{4}[.][0-9]{1,}[.][0-9]{1,}$" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin", "Adapters.apiread"], - "CookieAuth": ["Adapters.admin", "Adapters.apiread"], - "BasicAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": true - } - }, - "/adapters/{name}/start": { - "put": { - "summary": "Start an adapter.", - "description": "Start an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.startAdapter", - "responses": { - "200": { - "description": "The result of the start process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin"], - "CookieAuth": ["Adapters.admin"], - "BasicAuth": ["Adapters.admin"] - } - ], - "deprecated": false - } - }, - "/adapters/{name}/stop": { - "put": { - "summary": "Stop an adapter.", - "description": "Stop an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.stopAdapter", - "responses": { - "200": { - "description": "The result of the stop process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin"], - "CookieAuth": ["Adapters.admin"], - "BasicAuth": ["Adapters.admin"] - } - ], - "deprecated": false - } - }, - "/adapters/{name}/restart": { - "put": { - "summary": "Restart an adapter.", - "description": "Restart an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.restartAdapter", - "responses": { - "200": { - "description": "The result of the restart process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin"], - "CookieAuth": ["Adapters.admin"], - "BasicAuth": ["Adapters.admin"] - } - ], - "deprecated": false - } - }, - "/adapters/{name}/loglevel": { - "put": { - "summary": "Update the log levels.", - "description": "Update the log levels for an adapter.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.updateAdapterLogging", - "responses": { - "200": { - "description": "The result of updating the log levels for an adapter.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin"], - "CookieAuth": ["Adapters.admin"], - "BasicAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "transport": { - "type": "string", - "enum": ["file", "console", "syslog"] - } - }, - "if": { - "properties": { - "transport": { - "const": "syslog" - } - } - }, - "then": { - "properties": { - "level": { - "$ref": "#/components/schemas/iap_services-schema_sys_log_level" - } - } - }, - "else": { - "properties": { - "level": { - "$ref": "#/components/schemas/iap_services-schema_log_level" - } - } - } - } - } - } - } - } - } - } - }, - "/adapters/{name}/properties": { - "put": { - "summary": "Update the properties of an adapter.", - "description": "Update the properties of an adapter in IAP.", - "tags": ["adapters"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Adapters.updateAdapterProperties", - "responses": { - "200": { - "description": "The output of the adapter properties update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin"], - "CookieAuth": ["Adapters.admin"], - "BasicAuth": ["Adapters.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties" - } - } - } - } - } - } - } - }, - "/adapters/brokers/mapping": { - "get": { - "summary": "Get a mapping between brokers and adapters.", - "description": "Get a mapping between brokers and adapters.", - "tags": ["adapters"], - "parameters": [], - "operationId": "Adapters.getBrokerMap", - "responses": { - "200": { - "description": "Mapping between brokers and adapters in IAP.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "examples": [ - { - "aaa": ["Local AAA"] - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Adapters.admin", "Adapters.apiread"], - "CookieAuth": ["Adapters.admin", "Adapters.apiread"], - "BasicAuth": ["Adapters.admin", "Adapters.apiread"] - } - ], - "deprecated": false - } - }, - "/whoami": { - "get": { - "summary": "Gets the authorization data for the logged in user", - "description": "Gets the authorization data for the logged in user", - "tags": ["authentication"], - "parameters": [ - { - "name": "roles", - "in": "query", - "description": "roles", - "required": false, - "schema": { - "type": "string", - "enum": ["names", "ids"] - } - } - ], - "operationId": "Authentication.whoAmI", - "responses": { - "200": { - "description": "Authorization data for a user", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "type": "string", - "description": "The name of the AAA adapter from which the user logged in", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "description": "The username of the logged in user", - "examples": ["jane_doe"] - }, - "firstname": { - "type": "string", - "description": "The first name of the logged in user", - "examples": ["Jane"] - }, - "groups": { - "type": "array", - "description": "An array of groups which contain the logged in user", - "items": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "type": "string", - "description": "The name of the AAA adapter which contains the group", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "description": "The name of the group", - "examples": ["admin_group"] - } - } - } - }, - "roles": { - "type": "array", - "description": "Array of roles user has access to", - "items": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - }, - "roleNames": { - "type": "array", - "description": "Array of role names that user has access to", - "items": { - "type": "string" - } - }, - "routes": { - "type": "array", - "description": "Array of routes logged in user has access to", - "items": { - "type": "string", - "examples": ["/admin/"] - } - }, - "methods": { - "type": "object", - "description": "Map of service names and method names which the user has access to", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "description": "The name of a method within an application", - "examples": ["getProfiles"] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/mySession": { - "get": { - "summary": "Gets the session document for the active user", - "description": "Gets the session for the active user", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getMySession", - "responses": { - "200": { - "description": "The session document for the logged in user.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The session token for the logged in user" - }, - "loginMethod": { - "type": "string", - "description": "The way a user logged in", - "enum": ["Web", "sudo"] - }, - "session_start": { - "type": "integer", - "description": "The Unix epoch time when the session started" - }, - "ttl": { - "type": "integer", - "description": "The default ttl for a user session" - }, - "principalId": { - "type": "string", - "description": "The accountId for the logged in user" - }, - "requestCount": { - "type": "integer", - "description": "The number of API requests made during the active session" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/myPrincipal": { - "get": { - "summary": "Gets the principal document for the active user", - "description": "Gets the principal for the active user", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getMyPrincipal", - "responses": { - "200": { - "description": "The principal document for the logged in user", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "type": "string", - "description": "The name of the AAA adapter from which the user logged in", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "description": "The username of the logged in user", - "examples": ["jane_doe"] - }, - "firstname": { - "type": "string", - "description": "The first name of the logged in user", - "examples": ["Jane"] - }, - "groups": { - "type": "array", - "description": "An array of groups which contain the logged in user", - "items": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "type": "string", - "description": "The name of the AAA adapter which contains the group", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "description": "The name of the group", - "examples": ["admin_group"] - } - } - } - }, - "roles": { - "type": "array", - "description": "Array of roles user has access to", - "items": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - }, - "roleNames": { - "type": "array", - "description": "Array of role names user has access to", - "items": { - "type": "string" - } - }, - "allowedMethods": { - "type": "array", - "description": "The API methods which a user has access to", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "description": "The service which contains the method", - "examples": ["AutomationStudio"] - }, - "name": { - "type": "string", - "description": "The name of the method", - "examples": ["getTemplates"] - } - } - } - }, - "allowedViews": { - "type": "array", - "description": "The URL pages which a user has access to", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "description": "The service which contains the view", - "examples": ["AutomationStudio"] - }, - "path": { - "type": "string", - "description": "The URL route to the view", - "examples": ["/automation-studio/"] - } - } - } - }, - "routes": { - "type": "array", - "description": "Array of routes logged in user has access to", - "items": { - "type": "string", - "examples": ["/admin/"] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/myTtl": { - "get": { - "summary": "Get the number of seconds until the logged in user's session expires.", - "description": "Get the number of seconds until the user is logged out.", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getMyTtl", - "responses": { - "200": { - "description": "The number of seconds until the logged in user's session expires", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "integer" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/sso": { - "get": { - "summary": "Log in and create a session in IAP using single sign on", - "description": "Log into IAP using single sign on", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.sso", - "responses": { - "200": { - "description": "No output.", - "content": { - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/sso/test/{name}": { - "get": { - "summary": "Test logging into IAP using a saved single sign on configuration", - "description": "Test logging into IAP using single sign on", - "tags": ["authentication"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "Authentication.ssoTest", - "responses": { - "200": { - "description": "No output.", - "content": { - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/saml/callback": { - "post": { - "summary": "This the route used by the SAML identity provider to callback to IAP with the authentication response. This is not meant for manual use.", - "description": "Callback used by the SAML identity provider", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.samlCallback", - "responses": { - "200": { - "description": "No output.", - "content": { - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/sso/enabled": { - "get": { - "summary": "Get whether or not single sign on is enabled", - "description": "Get whether or not single sign on is enabled", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.isSSOEnabled", - "responses": { - "200": { - "description": "Whether or not single sign on is enabled", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/login": { - "post": { - "summary": "Log in an create a session in IAP", - "description": "Log in to IAP", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.login", - "responses": { - "200": { - "description": "The session token for a logged in user", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string", - "examples": ["MTQ4ZmMzMGMxOTQ2MTg4N2ZjMDhiMTY0MzlkYTgwZmM="] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false, - "requestBody": { - "description": "credentials", - "content": { - "application/json": { - "schema": { - "title": "credentials", - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - } - } - } - } - } - } - } - }, - "/logout": { - "get": { - "summary": "Log out of IAP and delete current session", - "description": "Log out of IAP", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.logout", - "responses": { - "200": { - "description": "The return data from logging out", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string", - "examples": ["You have successfully logged out."] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/download": { - "get": { - "summary": "Download a public file from IAP", - "description": "Download a public file from IAP", - "tags": ["authentication"], - "parameters": [ - { - "name": "file_name", - "in": "query", - "description": "file_name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "operationId": "Authentication.download", - "responses": { - "200": { - "description": "The contents of the file downloaded", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string", - "examples": ["this is the contents of a file"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/system/id": { - "get": { - "summary": "Get system server id.", - "description": "Get system server id for the current IAP.", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getSystemId", - "responses": { - "200": { - "description": "serverId of the current IAP.", - "content": { - "application/json": { - "schema": { - "title": "serverId", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/version": { - "get": { - "summary": "Get verion.", - "description": "Get release verion of current IAP.", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getReleaseVersion", - "responses": { - "200": { - "description": "Release Version of the current IAP.", - "content": { - "application/json": { - "schema": { - "title": "releaseVersion", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/config/apps": { - "get": { - "summary": "Get all application configs in IAP.", - "description": "Get all application configs in IAP.", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.getApplicationConfigs", - "responses": { - "200": { - "description": "Contains the configuration of all applications.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "title": "id", - "type": "string" - }, - "export": { - "title": "export", - "type": "string" - }, - "title": { - "title": "title", - "type": "string" - }, - "type": { - "title": "type", - "type": "string" - }, - "summary": { - "title": "summary", - "type": "string" - }, - "pdb": { - "title": "pdb", - "type": "boolean" - }, - "roles": { - "title": "roles", - "type": "array", - "items": { - "type": "string" - } - }, - "methods": { - "title": "methods", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "description": { - "title": "description", - "type": "string" - }, - "summary": { - "title": "summary", - "type": "string" - }, - "deprecated": { - "title": "deprecated", - "type": "boolean" - }, - "roles": { - "title": "roles", - "type": "array", - "items": { - "type": "string" - } - }, - "route": { - "title": "route", - "type": "object", - "properties": { - "path": { - "title": "path", - "type": "string" - }, - "verb": { - "title": "verb", - "type": "string" - } - } - }, - "input": { - "title": "input", - "type": "array", - "items": { - "type": "object" - } - }, - "output": { - "title": "output", - "type": "object" - } - } - } - }, - "views": { - "title": "views", - "type": "array", - "items": { - "type": "object" - } - }, - "src": { - "title": "src", - "type": "string" - }, - "encrypted": { - "title": "encrypted", - "type": "boolean" - }, - "version": { - "title": "version", - "type": "string" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/profile/{username}": { - "get": { - "summary": "Gets the user profile for the active user", - "description": "Gets the user profile for the active user", - "tags": ["authentication"], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The exact username for the logged in user", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema_username" - } - } - ], - "operationId": "Authentication.getUserProfile", - "responses": { - "200": { - "description": "The account document for the logged in user.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": true - } - }, - "/profile/update": { - "put": { - "summary": "Updates the user profile for the active user", - "description": "Updates the user profile for the active user", - "tags": ["authentication"], - "parameters": [], - "operationId": "Authentication.updateUserProfile", - "responses": { - "200": { - "description": "Updated account document for current user", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": true, - "requestBody": { - "description": "userProfile", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "username": { - "$ref": "#/components/schemas/iap_accounts-schema_username" - }, - "email": { - "$ref": "#/components/schemas/iap_accounts-schema_email" - } - }, - "required": ["username"], - "additionalProperties": false - } - } - } - } - } - }, - "/adapter-models/types": { - "get": { - "summary": "Get the list of available adapter model types.", - "description": "Get the list of available adapter model types in the current IAP.", - "tags": ["adapter-models"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["profile1"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["profile1"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["profile"] - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "AdapterModels.getAdapterModelTypes", - "responses": { - "200": { - "description": "Contains an array of adapter model types and the total.", - "content": { - "application/json": { - "schema": { - "title": "adapterModels", - "type": "object", - "required": ["adapterModels", "total"], - "properties": { - "adapterModels": { - "type": "array", - "items": { - "type": "string", - "examples": ["local_aaa", "redis"] - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AdapterModels.admin", "AdapterModels.apiread"], - "CookieAuth": ["AdapterModels.admin", "AdapterModels.apiread"], - "BasicAuth": ["AdapterModels.admin", "AdapterModels.apiread"] - } - ], - "deprecated": false - } - }, - "/integration-models": { - "post": { - "summary": "Create a new integration model.", - "description": "Create a new integration model in IAP.", - "tags": ["integration-models"], - "parameters": [], - "operationId": "IntegrationModels.createIntegrationModel", - "responses": { - "200": { - "description": "The output of the integration model creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "type": "object", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "model": { - "title": "model", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - } - }, - "get": { - "summary": "Get all integration models.", - "description": "Get all the integration models in IAP.", - "tags": ["integration-models"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "Filter the response based on each item that includes the provided query.", - "required": false, - "schema": { - "type": "string", - "description": "Filter the response based on each item that includes the provided query.", - "examples": ["git", "hub", "v5"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "enum": ["versionId"] - } - }, - { - "name": "equals", - "in": "query", - "description": "Filter the response based on each item that is an exact match to the provided query.", - "required": false, - "schema": { - "type": "string", - "description": "Filter the response based on each item that is an exact match to the provided query.", - "examples": ["GitHub:v5"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "enum": ["versionId"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "Filter the response based on each item that starts with the provided query.", - "required": false, - "schema": { - "type": "string", - "description": "Filter the response based on each item that starts with the provided query.", - "examples": ["g"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "enum": ["versionId"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by. Default is versionId.", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by. Default is versionId.", - "enum": ["versionId"] - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "IntegrationModels.getIntegrationModels", - "responses": { - "200": { - "description": "Contains the data for all integration models.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "integrationModels": { - "type": "object", - "properties": { - "model": { - "type": "string", - "examples": ["@itential/adapter_GitHub:v5"] - }, - "versionId": { - "type": "string", - "examples": ["GitHub:v5"] - }, - "description": { - "type": "string", - "examples": [ - "A standard description about the integration model" - ] - }, - "properties": { - "type": "object", - "description": "Refer to OpenAPI specifications for the available properties for this OpenAPI document." - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ], - "CookieAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ], - "BasicAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an integration model.", - "description": "Update an integration model in IAP.", - "tags": ["integration-models"], - "parameters": [], - "operationId": "IntegrationModels.updateIntegrationModel", - "responses": { - "200": { - "description": "The output of the update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "type": "object", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "model": { - "title": "model", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - } - } - }, - "/integration-models/{name}": { - "delete": { - "summary": "Delete an integration model.", - "description": "Delete an integration model from IAP.", - "tags": ["integration-models"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the integration model.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["GitHub:v5"] - } - } - ], - "operationId": "IntegrationModels.deleteIntegrationModel", - "responses": { - "200": { - "description": "The output of the integration model deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a specific integration model.", - "description": "Get a specific integration model in IAP.", - "tags": ["integration-models"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the integration model.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["Gitlab:v5"] - } - } - ], - "operationId": "IntegrationModels.getIntegrationModel", - "responses": { - "200": { - "description": "Contains the data for a specific integration model.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "model": { - "type": "string", - "examples": ["@itential/adapter_GitHub:v5"] - }, - "versionId": { - "type": "string", - "examples": ["GitHub:v5"] - }, - "description": { - "type": "string", - "examples": [ - "A standard description about the integration model" - ] - }, - "properties": { - "type": "object", - "description": "Refer to OpenAPI specifications for the available properties for this OpenAPI document." - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ], - "CookieAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ], - "BasicAuth": [ - "IntegrationModels.admin", - "IntegrationModels.apiread" - ] - } - ], - "deprecated": false - } - }, - "/integration-models/{name}/export": { - "get": { - "summary": "Export an integration model.", - "description": "Export an integration model's open API spec.", - "tags": ["integration-models"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the integration model.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["GitHub:v5"] - } - } - ], - "operationId": "IntegrationModels.exportIntegrationModel", - "responses": { - "200": { - "description": "The integration model open api spec.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document.", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false - } - }, - "/integration-models/{name}/securitySchemes": { - "get": { - "summary": "Gets an integration model's security schemes.", - "description": "Projection simplification for exportIntegrationModel", - "tags": ["integration-models"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the integration model.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["GitHub:v5"] - } - } - ], - "operationId": "IntegrationModels.getIntegrationModelSecuritySchemes", - "responses": { - "200": { - "description": "The integration model's security schemes according to its open api spec.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "description": "Refer to OpenAPI specifications for the structure of the security schemes of an OpenAPI document.", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false - } - }, - "/integration-models/validation": { - "put": { - "summary": "Validate an integration model.", - "description": "Validate an integration model.", - "tags": ["integration-models"], - "parameters": [], - "operationId": "IntegrationModels.validateIntegrationModel", - "responses": { - "200": { - "description": "The output of the integration model validation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "description": "Message containing either confirmation that the OpenAPI document is valid or validation errors related to the OpenAPI document.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["IntegrationModels.admin"], - "CookieAuth": ["IntegrationModels.admin"], - "BasicAuth": ["IntegrationModels.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "model": { - "title": "model", - "description": "Refer to OpenAPI specifications for the structure of an OpenAPI document." - } - } - } - } - } - } - } - }, - "/integrations": { - "post": { - "summary": "Create a new integration.", - "description": "Create a new integration in IAP.", - "tags": ["integrations"], - "parameters": [], - "operationId": "Integrations.createIntegration", - "responses": { - "200": { - "description": "The result of the integration creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "model": { - "$ref": "#/components/schemas/iap_services-schema_model" - }, - "name": { - "$ref": "#/components/schemas/iap_services-schema_name" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "$ref": "#/components/schemas/iap_services-schema_properties" - }, - "virtual": { - "$ref": "#/components/schemas/iap_services-schema_virtual" - } - }, - "required": ["name", "type", "properties", "virtual"] - } - } - } - } - } - } - }, - "get": { - "summary": "Get all integrations.", - "description": "Get all integrations in IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["GitHub"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["GitHub"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["GitHub"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "skipActiveSync", - "in": "query", - "description": "skipActiveSync", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - } - ], - "operationId": "Integrations.getIntegrations", - "responses": { - "200": { - "description": "Contains an array of integrations and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Integrations.admin", "Integrations.apiread"], - "CookieAuth": ["Integrations.admin", "Integrations.apiread"], - "BasicAuth": ["Integrations.admin", "Integrations.apiread"] - } - ], - "deprecated": false - } - }, - "/integrations/{name}": { - "delete": { - "summary": "Delete an integration.", - "description": "Delete an integration from IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.deleteIntegration", - "responses": { - "200": { - "description": "The output of the integration deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a single integration.", - "description": "Get a single integration in IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.getIntegration", - "responses": { - "200": { - "description": "Contains the data of a single integration.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Integrations.admin", "Integrations.apiread"], - "CookieAuth": ["Integrations.admin", "Integrations.apiread"], - "BasicAuth": ["Integrations.admin", "Integrations.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an integration.", - "description": "Update an integration in IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Contains the name for the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.updateIntegration", - "responses": { - "200": { - "description": "The output of the integration update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "$ref": "#/components/schemas/iap_services-schema_properties" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/integrations/{name}/authCode": { - "post": { - "summary": "Posts an access token with an Authorization Code", - "description": "Initiates the Authorization Code exchange for an access token and stores the change", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.postAuthFlowAccessToken", - "responses": { - "200": { - "description": "The success of the operation", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "description": "Some description", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "authorizationCode": { - "title": "authorizationCode", - "type": "string" - }, - "redirectUri": { - "title": "redirectUri", - "type": "string" - } - } - } - } - } - } - } - }, - "/integrations/{name}/properties": { - "put": { - "summary": "Update the properties of an integration.", - "description": "Update the properties of an integration in IAP.", - "tags": ["integrations"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected integration.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Integrations.updateIntegrationProperties", - "responses": { - "200": { - "description": "The output of the integration properties update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Integrations.admin"], - "CookieAuth": ["Integrations.admin"], - "BasicAuth": ["Integrations.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties" - } - } - } - } - } - } - } - }, - "/server/config": { - "get": { - "summary": "Get the full IAP configuration.", - "description": "Returns the full IAP configuration, with value/origin definitions for each property.", - "tags": ["server"], - "parameters": [], - "operationId": "Server.getConfig", - "responses": { - "200": { - "description": "The full IAP configuration.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "array", - "items": { - "type": "object", - "required": ["name", "value", "origin"], - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": [ - "null", - "string", - "boolean", - "number", - "object", - "array" - ] - }, - "origin": { - "type": "string" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Server.admin", "Server.apiread"], - "CookieAuth": ["Server.admin", "Server.apiread"], - "BasicAuth": ["Server.admin", "Server.apiread"] - } - ], - "deprecated": false - } - }, - "/server/config/{key}": { - "get": { - "summary": "Get a single IAP configuration property.", - "description": "Returns a single IAP configuration property, with value/origin definitions.", - "tags": ["server"], - "parameters": [ - { - "name": "key", - "in": "path", - "description": "The configuration property key.", - "required": true, - "schema": {} - } - ], - "operationId": "Server.getConfigProperty", - "responses": { - "200": { - "description": "The value and origin of the requested property.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "required": ["name", "value", "origin"], - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": [ - "null", - "string", - "boolean", - "number", - "object", - "array" - ] - }, - "origin": { - "type": "string" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Server.admin", "Server.apiread"], - "CookieAuth": ["Server.admin", "Server.apiread"], - "BasicAuth": ["Server.admin", "Server.apiread"] - } - ], - "deprecated": false - } - }, - "/applications/{name}": { - "get": { - "summary": "Get a single application.", - "description": "Get a single application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.getApplication", - "responses": { - "200": { - "description": "Contains the data of a single application.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - }, - "required": ["isActive"] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Applications.admin", "Applications.apiread"], - "CookieAuth": ["Applications.admin", "Applications.apiread"], - "BasicAuth": ["Applications.admin", "Applications.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an application.", - "description": "Update an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.updateApplication", - "responses": { - "200": { - "description": "The output of the application update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "loggerProps": { - "$ref": "#/components/schemas/iap_services-schema_loggerProps" - }, - "isEncrypted": { - "$ref": "#/components/schemas/iap_services-schema_isEncrypted" - }, - "type": { - "$ref": "#/components/schemas/iap_services-schema_type" - }, - "properties": { - "$ref": "#/components/schemas/iap_services-schema_properties" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/applications/{name}/changelogs": { - "get": { - "summary": "Get the list of changelogs.", - "description": "Get the list of changelogs for a specific application.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - }, - { - "name": "release", - "in": "query", - "description": "release", - "required": false, - "schema": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - } - } - ], - "operationId": "Applications.getApplicationChangelogs", - "responses": { - "200": { - "description": "The list of changelogs available for the requested application.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "string", - "examples": [ - { - "2020.1.1": "Changelog for 2020.1" - } - ], - "pattern": "^[0-9]{4}[.][0-9]{1,}[.][0-9]{1,}$" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Applications.admin", "Applications.apiread"], - "CookieAuth": ["Applications.admin", "Applications.apiread"], - "BasicAuth": ["Applications.admin", "Applications.apiread"] - } - ], - "deprecated": true - } - }, - "/applications": { - "get": { - "summary": "Get all applications.", - "description": "Get all applications in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Applications.getApplications", - "responses": { - "200": { - "description": "Contains an array of applications and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "oneOf": [ - { - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - } - }, - { - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - } - } - } - ] - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Applications.admin", "Applications.apiread"], - "CookieAuth": ["Applications.admin", "Applications.apiread"], - "BasicAuth": ["Applications.admin", "Applications.apiread"] - } - ], - "deprecated": false - } - }, - "/applications/{name}/start": { - "put": { - "summary": "Start an application.", - "description": "Start an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.startApplication", - "responses": { - "200": { - "description": "The result of the start process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false - } - }, - "/applications/{name}/stop": { - "put": { - "summary": "Stop an application.", - "description": "Stop an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.stopApplication", - "responses": { - "200": { - "description": "The result of the stop process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false - } - }, - "/applications/{name}/restart": { - "put": { - "summary": "Restart an application.", - "description": "Restart an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.restartApplication", - "responses": { - "200": { - "description": "The result of the restart process contains the status of the command.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false - } - }, - "/applications/{name}/loglevel": { - "put": { - "summary": "Update the log levels.", - "description": "Update the log levels for an application.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.updateApplicationLogging", - "responses": { - "200": { - "description": "The result of updating the log levels for an application.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "transport": { - "type": "string", - "enum": ["file", "console", "syslog"] - } - }, - "if": { - "properties": { - "transport": { - "const": "syslog" - } - } - }, - "then": { - "properties": { - "level": { - "$ref": "#/components/schemas/iap_services-schema_sys_log_level" - } - } - }, - "else": { - "properties": { - "level": { - "$ref": "#/components/schemas/iap_services-schema_log_level" - } - } - } - } - } - } - } - } - } - } - }, - "/applications/{name}/properties": { - "put": { - "summary": "Update the properties of an application.", - "description": "Update the properties of an application in IAP.", - "tags": ["applications"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Applications.updateApplicationProperties", - "responses": { - "200": { - "description": "The output of the application properties update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_services-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Applications.admin"], - "CookieAuth": ["Applications.admin"], - "BasicAuth": ["Applications.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties" - } - } - } - } - } - } - } - }, - "/user/settings": { - "get": { - "summary": "Gets the user settings for the active user", - "description": "Gets the user settings for the active user", - "tags": ["user"], - "parameters": [], - "operationId": "UserSettings.getUserSettings", - "responses": { - "200": { - "description": "The account document for the logged in user.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Updates the user settings for the active user", - "description": "Updates the user settings for the active user", - "tags": ["user"], - "parameters": [], - "operationId": "UserSettings.updateUserSettings", - "responses": { - "200": { - "description": "Updated account document for current user", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "type": "object", - "properties": { - "gitTokens": { - "$ref": "#/components/schemas/iap_accounts-schema_gitTokens" - }, - "email": { - "$ref": "#/components/schemas/iap_accounts-schema_email" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/schema/adapters/{name}": { - "get": { - "summary": "Get the adapter schema.", - "description": "Get the adapter schema.", - "tags": ["schema"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["redis", "email"] - } - } - ], - "operationId": "Schema.getAdapterSchema", - "responses": { - "200": { - "description": "Contains the schema for an adapter.", - "content": { - "application/json": { - "schema": { - "title": "schema", - "type": "object", - "properties": { - "schema": { - "$ref": "#/components/schemas/iap_services-schema" - }, - "decorators": { - "$ref": "#/components/schemas/iap_decorators-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Schema.admin", "Schema.apiread"], - "CookieAuth": ["Schema.admin", "Schema.apiread"], - "BasicAuth": ["Schema.admin", "Schema.apiread"] - } - ], - "deprecated": false - } - }, - "/schema/applications/{name}": { - "get": { - "summary": "Get the application schema.", - "description": "Get the application schema.", - "tags": ["schema"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["redis", "email"] - } - } - ], - "operationId": "Schema.getApplicationSchema", - "responses": { - "200": { - "description": "Contains the schema for an application.", - "content": { - "application/json": { - "schema": { - "title": "schema", - "type": "object", - "properties": { - "schema": { - "$ref": "#/components/schemas/iap_services-schema" - }, - "decorators": { - "$ref": "#/components/schemas/iap_decorators-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Schema.admin", "Schema.apiread"], - "CookieAuth": ["Schema.admin", "Schema.apiread"], - "BasicAuth": ["Schema.admin", "Schema.apiread"] - } - ], - "deprecated": false - } - }, - "/schema/integrations/{name}": { - "get": { - "summary": "Get the integration schema.", - "description": "Get the integration schema.", - "tags": ["schema"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected integration.", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["ghv5", "ghv6"] - } - } - ], - "operationId": "Schema.getIntegrationSchema", - "responses": { - "200": { - "description": "Contains the schema for an integration.", - "content": { - "application/json": { - "schema": { - "title": "schema", - "type": "object", - "properties": { - "schema": { - "$ref": "#/components/schemas/iap_services-schema" - }, - "decorators": { - "$ref": "#/components/schemas/iap_decorators-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Schema.admin", "Schema.apiread"], - "CookieAuth": ["Schema.admin", "Schema.apiread"], - "BasicAuth": ["Schema.admin", "Schema.apiread"] - } - ], - "deprecated": false - } - }, - "/schema/profiles": { - "get": { - "summary": "Get the profile schema.", - "description": "Get the profile schema.", - "tags": ["schema"], - "parameters": [], - "operationId": "Schema.getProfileSchema", - "responses": { - "200": { - "description": "Contains the schema for profiles.", - "content": { - "application/json": { - "schema": { - "title": "schema", - "type": "object", - "properties": { - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema" - }, - "decorators": { - "$ref": "#/components/schemas/iap_decorators-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Schema.admin", "Schema.apiread"], - "CookieAuth": ["Schema.admin", "Schema.apiread"], - "BasicAuth": ["Schema.admin", "Schema.apiread"] - } - ], - "deprecated": false - } - }, - "/customization/banner": { - "get": { - "summary": "Get banner.", - "description": "Get banner for customization", - "tags": ["customization"], - "parameters": [], - "operationId": "Customization.getBanner", - "responses": { - "200": { - "description": "The banner object from the database", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/iap_banner-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update the banner.", - "description": "Update the banner", - "tags": ["customization"], - "parameters": [], - "operationId": "Customization.updateBanner", - "responses": { - "200": { - "description": "The result from the database", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Customization.admin"], - "CookieAuth": ["Customization.admin"], - "BasicAuth": ["Customization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_banner-schema" - } - } - } - } - } - }, - "/help/adapters/html": { - "get": { - "summary": "Generate documentation for adapters", - "description": "Generate an HTML documentation page for adapters", - "tags": ["help"], - "parameters": [], - "operationId": "Help.getAdaptersHtml", - "responses": { - "200": { - "description": "HTML string containing documentation for adapter functions.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/help/brokers/html": { - "get": { - "summary": "Generate documentation for brokers", - "description": "Generate an HTML documentation page for brokers", - "tags": ["help"], - "parameters": [], - "operationId": "Help.getBrokersHtml", - "responses": { - "200": { - "description": "HTML string containing documentation for broker functions.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/help/applications/html": { - "get": { - "summary": "Generate documentation for applications", - "description": "Generate an HTML documentation page for applications", - "tags": ["help"], - "parameters": [], - "operationId": "Help.getApplicationsHtml", - "responses": { - "200": { - "description": "HTML string containing documentation for application functions.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/help/openapi": { - "get": { - "summary": "Generate an OpenAPI v3 document for IAP", - "description": "Generate an OpenAPI v3.1.0 document for IAP", - "tags": ["help"], - "parameters": [ - { - "name": "url", - "in": "query", - "description": "url", - "required": false, - "schema": { - "type": "string", - "examples": ["http://localhost:3000"] - } - } - ], - "operationId": "Help.getOpenApi", - "responses": { - "200": { - "description": "An OpenAPI v3 document containing all IAP routes", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/indexes": { - "get": { - "summary": "Get all pre-defined indexes.", - "description": "Get all pre-defined indexes to be used in Mongo.", - "tags": ["indexes"], - "parameters": [ - { - "name": "application", - "in": "query", - "description": "application", - "required": false, - "schema": { - "type": "string", - "examples": ["@itential/app-workflow_engine"] - } - } - ], - "operationId": "Indexes.getIndexes", - "responses": { - "200": { - "description": "Contains an array of pre-defined Mongo indexes.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Indexes.admin", "Indexes.apiread"], - "CookieAuth": ["Indexes.admin", "Indexes.apiread"], - "BasicAuth": ["Indexes.admin", "Indexes.apiread"] - } - ], - "deprecated": false - } - }, - "/indexes/{collection}/status": { - "get": { - "summary": "Check the status of a collection's indexes in Mongo", - "description": "Check the status of pre-defined indexes for a specific collection.", - "tags": ["indexes"], - "parameters": [ - { - "name": "collection", - "in": "path", - "description": "The name of a collection in Mongo.", - "required": true, - "schema": { - "type": "string", - "title": "collection", - "description": "The collection name in the database." - } - } - ], - "operationId": "Indexes.checkIndexes", - "responses": { - "200": { - "description": "The current statuses of the indexes on the specified collection.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "missing": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "misnamed": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "external": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "indexed": { - "type": "integer", - "minimum": 0 - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - }, - "collectionSize": { - "type": "integer" - }, - "inProgress": { - "type": "boolean" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Indexes.admin", "Indexes.apiread"], - "CookieAuth": ["Indexes.admin", "Indexes.apiread"], - "BasicAuth": ["Indexes.admin", "Indexes.apiread"] - } - ], - "deprecated": false - } - }, - "/indexes/status": { - "get": { - "summary": "Check the status of multiple collections' indexes in Mongo", - "description": "Check the status of pre-defined indexes for multiple collections.", - "tags": ["indexes"], - "parameters": [ - { - "name": "collections", - "in": "query", - "description": "collections", - "required": false, - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["accounts", "automations"]] - }, - { - "type": "string", - "examples": ["accounts"] - } - ] - } - } - ], - "operationId": "Indexes.checkMultipleIndexes", - "responses": { - "200": { - "description": "The current statuses of the indexes on the specified collections.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": {}, - "additionalProperties": { - "title": "result", - "type": "object", - "properties": { - "missing": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "misnamed": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_indexes-schema" - } - }, - "indexed": { - "type": "integer", - "minimum": 0 - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - }, - "collectionSize": { - "type": "integer" - }, - "inProgress": { - "type": "boolean" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Indexes.admin", "Indexes.apiread"], - "CookieAuth": ["Indexes.admin", "Indexes.apiread"], - "BasicAuth": ["Indexes.admin", "Indexes.apiread"] - } - ], - "deprecated": false - } - }, - "/indexes/{collection}": { - "post": { - "summary": "Create a collection's indexes in Mongo", - "description": "Create all pre-defined indexes for a specific collection.", - "tags": ["indexes"], - "parameters": [ - { - "name": "collection", - "in": "path", - "description": "The name of a collection in Mongo.", - "required": true, - "schema": { - "type": "string", - "title": "collection", - "description": "The collection name in the database." - } - } - ], - "operationId": "Indexes.createIndexes", - "responses": { - "200": { - "description": "The current status of the index creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "unchanged": { - "type": "integer", - "minimum": 0 - }, - "changed": { - "type": "integer", - "minimum": 0 - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - }, - "running": { - "type": "boolean" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Indexes.admin"], - "CookieAuth": ["Indexes.admin"], - "BasicAuth": ["Indexes.admin"] - } - ], - "deprecated": false - } - }, - "/authorization/accounts": { - "get": { - "summary": "Get all accounts.", - "description": "Get all accounts", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_accounts-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_accounts-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_accounts-query" - } - }, - { - "name": "inactive", - "in": "query", - "description": "inactive", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema_inactive" - } - }, - { - "name": "isServiceAccount", - "in": "query", - "description": "isServiceAccount", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema_isServiceAccount" - } - }, - { - "name": "groupId", - "in": "query", - "description": "groupId", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "loggedIn", - "in": "query", - "description": "loggedIn", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema_loggedIn" - } - } - ], - "operationId": "Authorization.getAccounts", - "responses": { - "200": { - "description": "The accounts matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_accounts-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - } - }, - "/authorization/accounts/{accountId}": { - "get": { - "summary": "Get an individual account.", - "description": "Get an individual account", - "tags": ["authorization"], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The id for the requested account.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.getAccount", - "responses": { - "200": { - "description": "The individual account document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update an account.", - "description": "Update an account", - "tags": ["authorization"], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The individual account to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.updateAccount", - "responses": { - "200": { - "description": "The output of the account update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_accounts-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "inactive": { - "$ref": "#/components/schemas/iap_accounts-schema_inactive" - }, - "email": { - "$ref": "#/components/schemas/iap_accounts-schema_email" - }, - "assignedRoles": { - "$ref": "#/components/schemas/iap_accounts-schema_assignedRoles" - }, - "memberOf": { - "$ref": "#/components/schemas/iap_accounts-schema_memberOf" - } - } - } - } - } - } - } - } - } - }, - "/authorization/accounts/{accountId}/forceLogout": { - "post": { - "summary": "Force a user to logout and remove their session.", - "description": "Force a user to logout", - "tags": ["authorization"], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The individual account to logout.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.forceLogout", - "responses": { - "200": { - "description": "The output of removing a session", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false - } - }, - "/authorization/groups": { - "get": { - "summary": "Get a list of groups.", - "description": "Get a list of groups", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "inactive", - "in": "query", - "description": "inactive", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_groups-schema_inactive" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "refresh", - "in": "query", - "description": "whether to refresh groups from AAA", - "required": false, - "schema": { - "type": "boolean", - "title": "refresh", - "description": "whether to refresh groups from AAA", - "default": false - } - } - ], - "operationId": "Authorization.getGroups", - "responses": { - "200": { - "description": "The groups matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_groups-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Create a group.", - "description": "Create a group", - "tags": ["authorization"], - "parameters": [], - "operationId": "Authorization.createGroup", - "responses": { - "200": { - "description": "Result of group creation process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_groups-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "$ref": "#/components/schemas/iap_groups-schema" - } - } - } - } - } - } - } - }, - "/authorization/groups/list": { - "get": { - "summary": "Get a simplified list of groups.", - "description": "Get a simplified list of groups", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_groups-query" - } - }, - { - "name": "inactive", - "in": "query", - "description": "inactive", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_groups-schema_inactive" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "refresh", - "in": "query", - "description": "whether to refresh groups from AAA", - "required": false, - "schema": { - "type": "boolean", - "title": "refresh", - "description": "whether to refresh groups from AAA", - "default": false - } - } - ], - "operationId": "Authorization.getGroupsShortList", - "responses": { - "200": { - "description": "The groups matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - }, - "provenance": { - "$ref": "#/components/schemas/iap_groups-schema_provenance" - }, - "name": { - "$ref": "#/components/schemas/iap_groups-schema_name" - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/authorization/groups/{groupId}": { - "get": { - "summary": "Get an individual group.", - "description": "Get an individual group", - "tags": ["authorization"], - "parameters": [ - { - "name": "groupId", - "in": "path", - "description": "The id for the requested group.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.getGroup", - "responses": { - "200": { - "description": "The individual group document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_groups-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update a group.", - "description": "Update a group", - "tags": ["authorization"], - "parameters": [ - { - "name": "groupId", - "in": "path", - "description": "The individual group to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.updateGroup", - "responses": { - "200": { - "description": "The output of the group update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_groups-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/iap_groups-schema_description" - }, - "inactive": { - "$ref": "#/components/schemas/iap_groups-schema_inactive" - }, - "memberOf": { - "$ref": "#/components/schemas/iap_groups-schema_memberOf" - }, - "assignedRoles": { - "$ref": "#/components/schemas/iap_groups-schema_assignedRoles" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a group.", - "description": "Delete a group", - "tags": ["authorization"], - "parameters": [ - { - "name": "groupId", - "in": "path", - "description": "The individual group to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Authorization.deleteGroup", - "responses": { - "200": { - "description": "Result of group deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false - } - }, - "/authorization/roles": { - "get": { - "summary": "Get a list of roles.", - "description": "Get a list of roles", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roles-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roles-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roles-query" - } - }, - { - "name": "inactive", - "in": "query", - "description": "inactive", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Authorization.getRoles", - "responses": { - "200": { - "description": "The roles matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_roles-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Create a role.", - "description": "Create a role", - "tags": ["authorization"], - "parameters": [], - "operationId": "Authorization.createRole", - "responses": { - "200": { - "description": "Result of role creation process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_roles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/iap_roles-schema" - } - } - } - } - } - } - } - }, - "/authorization/roles/{roleId}": { - "get": { - "summary": "Get an individual role.", - "description": "Get an individual role", - "tags": ["authorization"], - "parameters": [ - { - "name": "roleId", - "in": "path", - "description": "The id for the requested role.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roleId" - } - } - ], - "operationId": "Authorization.getRole", - "responses": { - "200": { - "description": "The individual role document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_roles-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update a role.", - "description": "Update a role", - "tags": ["authorization"], - "parameters": [ - { - "name": "roleId", - "in": "path", - "description": "The individual role to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roleId" - } - } - ], - "operationId": "Authorization.updateRole", - "responses": { - "200": { - "description": "The output of the role update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_roles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/iap_roles-schema_description" - }, - "allowedMethods": { - "$ref": "#/components/schemas/iap_roles-schema_allowedMethods" - }, - "allowedViews": { - "$ref": "#/components/schemas/iap_roles-schema_allowedViews" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a role.", - "description": "Delete a role", - "tags": ["authorization"], - "parameters": [ - { - "name": "roleId", - "in": "path", - "description": "The individual role to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_authorization-common_roleId" - } - } - ], - "operationId": "Authorization.deleteRole", - "responses": { - "200": { - "description": "Result of role deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin"], - "CookieAuth": ["Authorization.admin"], - "BasicAuth": ["Authorization.admin"] - } - ], - "deprecated": false - } - }, - "/authorization/methods": { - "get": { - "summary": "Get a list of methods.", - "description": "Get a list of methods in IAP.", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_methods-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_methods-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_methods-query" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Authorization.getMethods", - "responses": { - "200": { - "description": "List of methods in IAP.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["getRoles"] - }, - "provenance": { - "type": "string", - "examples": ["Authorization"] - }, - "route": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/roles"] - }, - "verb": { - "type": "string", - "examples": ["GET"] - }, - "fullPath": { - "type": "string", - "examples": ["/authorization/roles"] - } - } - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - } - }, - "/authorization/views": { - "get": { - "summary": "Get a list of views.", - "description": "Get a list of views in IAP.", - "tags": ["authorization"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_views-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_views-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_system-common_views-query" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Authorization.getViews", - "responses": { - "200": { - "description": "List of views in IAP.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/"] - }, - "provenance": { - "type": "string", - "examples": ["WorkFlowEngine"] - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - } - }, - "/authorization/csv/export": { - "get": { - "summary": "Extract CSV data of accounts, groups, and roles", - "description": "Retrieve CSV data of accounts, groups, and roles information", - "tags": ["authorization"], - "parameters": [], - "operationId": "Authorization.exportAuthReport", - "responses": { - "200": { - "description": "Result of export", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Authorization.admin", "Authorization.apiread"], - "CookieAuth": ["Authorization.admin", "Authorization.apiread"], - "BasicAuth": ["Authorization.admin", "Authorization.apiread"] - } - ], - "deprecated": false - } - }, - "/device-counts": { - "get": { - "summary": "Get device count history", - "description": "Get device count history", - "tags": ["device-counts"], - "parameters": [ - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "type": "string", - "enum": ["newest", "oldest"], - "default": "newest" - } - }, - { - "name": "serverId", - "in": "query", - "description": "The server ID where the device counts came from", - "required": false, - "schema": { - "type": "string", - "description": "The server ID where the device counts came from" - } - }, - { - "name": "before", - "in": "query", - "description": "The timestamp in milliseconds used as an upper range. Should be higher than the after value.", - "required": false, - "schema": { - "type": "integer", - "description": "The timestamp in milliseconds used as an upper range. Should be higher than the after value." - } - }, - { - "name": "after", - "in": "query", - "description": "The timestamp in milliseconds used as a lower range. Should be lower than the after value.", - "required": false, - "schema": { - "type": "integer", - "description": "The timestamp in milliseconds used as a lower range. Should be lower than the after value." - } - } - ], - "operationId": "DeviceCounts.getDeviceCounts", - "responses": { - "200": { - "description": "The device counts matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_device-count-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["DeviceCounts.admin"], - "CookieAuth": ["DeviceCounts.admin"], - "BasicAuth": ["DeviceCounts.admin"] - } - ], - "deprecated": false - } - }, - "/device-counts/refresh": { - "post": { - "summary": "Refresh device count history", - "description": "Refresh device count history", - "tags": ["device-counts"], - "parameters": [], - "operationId": "DeviceCounts.createDeviceCount", - "responses": { - "200": { - "description": "Refresh device count history", - "content": { - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["DeviceCounts.admin"], - "CookieAuth": ["DeviceCounts.admin"], - "BasicAuth": ["DeviceCounts.admin"] - } - ], - "deprecated": false - } - }, - "/health/adapters/{name}": { - "get": { - "summary": "Get the health of a single adapter.", - "description": "Get the health of a single adapter in IAP.", - "tags": ["health"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected adapter.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Health.getAdapterHealth", - "responses": { - "200": { - "description": "Contains the selected adapters health data.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_services-health-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/applications/{name}": { - "get": { - "summary": "Get the health of a single application.", - "description": "Get the health of a single application in IAP.", - "tags": ["health"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name for the selected application.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_services-schema_name" - } - } - ], - "operationId": "Health.getApplicationHealth", - "responses": { - "200": { - "description": "Contains the selected applications health data.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_services-health-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/adapters": { - "get": { - "summary": "Get the health of all the adapters.", - "description": "Get the health of all the adapters in IAP.", - "tags": ["health"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Health.getAdaptersHealth", - "responses": { - "200": { - "description": "Contains the adapters health data.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_services-health-schema" - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/applications": { - "get": { - "summary": "Get the health of all the applications.", - "description": "Get the health of all the applications in IAP.", - "tags": ["health"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Health.getApplicationsHealth", - "responses": { - "200": { - "description": "Contains the applications health data.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_services-health-schema" - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/server": { - "get": { - "summary": "Get the health of the server.", - "description": "Get the health of the server.", - "tags": ["health"], - "parameters": [], - "operationId": "Health.getServerHealth", - "responses": { - "200": { - "description": "Contains the server health data.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "version": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "release": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "arch": { - "type": "string", - "enum": [ - "arm", - "arm64", - "ia32", - "mips", - "mipsel", - "ppc", - "ppc64", - "s390", - "s390x", - "x32", - "x64" - ] - }, - "platform": { - "type": "string", - "enum": [ - "aix", - "darwin", - "freebsd", - "linux", - "openbsd", - "sunos", - "win32" - ] - }, - "versions": { - "type": "object", - "properties": { - "node": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "v8": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "uv": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "zlib": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "brotli": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "ares": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "modules": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "nghttp2": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "napi": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "llhttp": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "http_parser": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "openssl": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "cldr": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "icu": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "tz": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "unicode": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - } - } - }, - "memoryUsage": { - "$ref": "#/components/schemas/iap_services-health-schema_memoryUsage" - }, - "cpuUsage": { - "$ref": "#/components/schemas/iap_services-health-schema_cpuUsage" - }, - "uptime": { - "$ref": "#/components/schemas/iap_services-health-schema_uptime" - }, - "pid": { - "$ref": "#/components/schemas/iap_services-health-schema_pid" - }, - "dependencies": { - "type": "object", - "properties": { - "@itential/logger": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "@itential/database": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "@itential/itential-utils": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/system": { - "get": { - "summary": "Get the health of the system.", - "description": "Get the health of the system.", - "tags": ["health"], - "parameters": [], - "operationId": "Health.getSystemHealth", - "responses": { - "200": { - "description": "Contains the system health data.", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "results", - "properties": { - "arch": { - "type": "string", - "examples": ["x64"] - }, - "release": { - "$ref": "#/components/schemas/iap_services-health-schema_version" - }, - "uptime": { - "type": "integer", - "examples": [12539] - }, - "freemem": { - "type": "integer", - "examples": [14377422848] - }, - "totalmem": { - "type": "integer", - "examples": [34359738368] - }, - "loadavg": { - "type": "array", - "items": { - "type": "number", - "examples": [3.0166015625, 1.74169921875] - } - }, - "cpus": { - "type": "array", - "items": { - "type": "object", - "required": ["model", "speed", "times"], - "properties": { - "model": { - "type": "string", - "examples": [ - "Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz" - ] - }, - "speed": { - "type": "integer", - "examples": [2300] - }, - "times": { - "type": "object", - "required": ["user", "nice", "sys", "idle", "irq"], - "properties": { - "user": { - "type": "integer", - "examples": [604790] - }, - "nice": { - "type": "integer", - "examples": [0] - }, - "sys": { - "type": "integer", - "examples": [322560] - }, - "idle": { - "type": "integer", - "examples": [6071010] - }, - "irq": { - "type": "integer", - "examples": [0] - } - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Health.admin", "Health.apiread"], - "CookieAuth": ["Health.admin", "Health.apiread"], - "BasicAuth": ["Health.admin", "Health.apiread"] - } - ], - "deprecated": false - } - }, - "/health/status": { - "get": { - "summary": "Get status.", - "description": "Get status of current IAP.", - "tags": ["health"], - "parameters": [], - "operationId": "Health.getHealthStatus", - "responses": { - "200": { - "description": "status of the current IAP.", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "serverId": { - "type": "string" - }, - "services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "service": { - "type": "string" - }, - "status": { - "type": "string", - "enum": ["running", "failed"] - } - } - } - }, - "timestamp": { - "type": "integer" - }, - "apps": { - "type": "string", - "enum": ["running", "degraded"] - }, - "adapters": { - "type": "string", - "enum": ["running", "degraded"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/prebuilts/{id}/export": { - "get": { - "summary": "Export a prebuilt", - "description": "Export a prebuilt from IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The object id of the selected prebuilt.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Prebuilts.exportPrebuilt", - "responses": { - "200": { - "description": "The data for a prebuilt.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] - } - ], - "deprecated": false - } - }, - "/prebuilts/{id}": { - "get": { - "summary": "Get a single prebuilt.", - "description": "Get a single prebuilt in IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The object id of the selected prebuilt.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Prebuilts.getPrebuilt", - "responses": { - "200": { - "description": "The data for a prebuilt.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Remove a prebuilt.", - "description": "Remove a prebuilt from IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The object id of the selected prebuilt.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Prebuilts.removePrebuilt", - "responses": { - "200": { - "description": "The output of the prebuilt removal process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Prebuilts.admin"], - "CookieAuth": ["Prebuilts.admin"], - "BasicAuth": ["Prebuilts.admin"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update a prebuilt", - "description": "Update a prebuilt in IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The object id of the selected prebuilt.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_objectId" - } - } - ], - "operationId": "Prebuilts.updatePrebuilt", - "responses": { - "200": { - "description": "The output of the prebuilt update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Prebuilts.admin"], - "CookieAuth": ["Prebuilts.admin"], - "BasicAuth": ["Prebuilts.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "prebuilt": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - } - } - } - } - }, - "/prebuilts": { - "get": { - "summary": "Get all the prebuilts.", - "description": "Get all the prebuilts in IAP.", - "tags": ["prebuilts"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["nso"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["artifact-wizard"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["n", "a"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "config", - "in": "query", - "description": "config", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_config" - } - } - ], - "operationId": "Prebuilts.getPrebuilts", - "responses": { - "200": { - "description": "Contains an array of prebuilts and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "required": ["packages", "total"], - "properties": { - "packages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "CookieAuth": ["Prebuilts.admin", "Prebuilts.apiread"], - "BasicAuth": ["Prebuilts.admin", "Prebuilts.apiread"] - } - ], - "deprecated": false - } - }, - "/prebuilts/import": { - "post": { - "summary": "Import a prebuilt.", - "description": "Import a prebuilt into IAP.", - "tags": ["prebuilts"], - "parameters": [], - "operationId": "Prebuilts.importPrebuilt", - "responses": { - "200": { - "description": "The output of the prebuilt import process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Prebuilts.admin"], - "CookieAuth": ["Prebuilts.admin"], - "BasicAuth": ["Prebuilts.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "prebuilt": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "overwrite": { - "type": "boolean", - "description": "If the import functionality should overwrite existing components", - "examples": [true, false] - } - } - } - } - } - } - } - } - } - }, - "/prebuilts/import/validation": { - "put": { - "summary": "Validate the data structure of a prebuilt.", - "description": "Validate the data structure of a prebuilt in IAP.", - "tags": ["prebuilts"], - "parameters": [], - "operationId": "Prebuilts.validatePrebuilt", - "responses": { - "200": { - "description": "The output of the prebuilt update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Prebuilts.admin"], - "CookieAuth": ["Prebuilts.admin"], - "BasicAuth": ["Prebuilts.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "prebuilt": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - } - } - } - } - }, - "/external-links": { - "get": { - "summary": "Get all links.", - "description": "Get all links", - "tags": ["external-links"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_links-query" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_links-query" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_links-query" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "ExternalLinks.getLinks", - "responses": { - "200": { - "description": "The links matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_links-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], - "CookieAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], - "BasicAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Update a link.", - "description": "Create a link", - "tags": ["external-links"], - "parameters": [], - "operationId": "ExternalLinks.createLink", - "responses": { - "200": { - "description": "Result of link creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_links-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["ExternalLinks.admin"], - "CookieAuth": ["ExternalLinks.admin"], - "BasicAuth": ["ExternalLinks.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "link": { - "$ref": "#/components/schemas/iap_links-schema" - } - } - } - } - } - } - } - }, - "/external-links/{linkId}": { - "get": { - "summary": "Get an individual link.", - "description": "Get an individual link", - "tags": ["external-links"], - "parameters": [ - { - "name": "linkId", - "in": "path", - "description": "The id for the requested link.", - "required": true, - "schema": { - "title": "linkId", - "type": "string" - } - } - ], - "operationId": "ExternalLinks.getLink", - "responses": { - "200": { - "description": "The individual link document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_links-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], - "CookieAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"], - "BasicAuth": ["ExternalLinks.admin", "ExternalLinks.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update a link.", - "description": "Update a link", - "tags": ["external-links"], - "parameters": [ - { - "name": "linkId", - "in": "path", - "description": "The individual link to update.", - "required": true, - "schema": { - "title": "linkId", - "type": "string" - } - } - ], - "operationId": "ExternalLinks.updateLink", - "responses": { - "200": { - "description": "The output of the link update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_links-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["ExternalLinks.admin"], - "CookieAuth": ["ExternalLinks.admin"], - "BasicAuth": ["ExternalLinks.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_links-schema_name" - }, - "address": { - "$ref": "#/components/schemas/iap_links-schema_address" - }, - "description": { - "$ref": "#/components/schemas/iap_links-schema_description" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a link.", - "description": "Delete a link", - "tags": ["external-links"], - "parameters": [ - { - "name": "linkId", - "in": "path", - "description": "The individual link to delete.", - "required": true, - "schema": { - "title": "linkId", - "type": "string" - } - } - ], - "operationId": "ExternalLinks.deleteLink", - "responses": { - "200": { - "description": "Result of link deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["ExternalLinks.admin"], - "CookieAuth": ["ExternalLinks.admin"], - "BasicAuth": ["ExternalLinks.admin"] - } - ], - "deprecated": false - } - }, - "/prebuilts-repository/configs": { - "post": { - "summary": "Create repository configuration", - "description": "Create a new repository configuration", - "tags": ["prebuilts-repository"], - "parameters": [], - "operationId": "PrebuiltsRepository.createRepositoryConfig", - "responses": { - "200": { - "description": "The result of the creation process", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_repository-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "config": { - "$ref": "#/components/schemas/iap_repository-schema" - } - } - } - } - } - } - }, - "get": { - "summary": "Get Repository Configurations", - "description": "Get all the Prebuilt Repository configurations", - "tags": ["prebuilts-repository"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["redis"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["name"] - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "PrebuiltsRepository.getRepositoryConfigs", - "responses": { - "200": { - "description": "Contains an array of prebuilts and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "required": ["results", "total"], - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_prebuilts-schema_name" - }, - "enabled": { - "$ref": "#/components/schemas/iap_repository-schema_enabled" - }, - "type": { - "$ref": "#/components/schemas/iap_repository-schema_type" - }, - "hostname": { - "$ref": "#/components/schemas/iap_repository-schema_hostname" - }, - "path": { - "$ref": "#/components/schemas/iap_repository-schema_path" - }, - "credentials": { - "$ref": "#/components/schemas/iap_repository-schema_credentials" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false - } - }, - "/prebuilts-repository/configs/{name}": { - "delete": { - "summary": "Delete repository configuration", - "description": "Delete an existing repository configuration", - "tags": ["prebuilts-repository"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the repository configuration", - "required": true, - "schema": { - "title": "name", - "type": "string" - } - } - ], - "operationId": "PrebuiltsRepository.deleteRepositoryConfig", - "responses": { - "200": { - "description": "The result of the delete process", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update repository configuration", - "description": "Update an existing repository configuration", - "tags": ["prebuilts-repository"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the repository configuration", - "required": true, - "schema": { - "title": "name", - "type": "string" - } - } - ], - "operationId": "PrebuiltsRepository.updateRepositoryConfig", - "responses": { - "200": { - "description": "The result of the update process", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_repository-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "A flag that denotes if the repository configuration is connected" - }, - "type": { - "type": "string", - "description": "The type of Repository", - "enum": ["gitlab"] - }, - "hostname": { - "type": "string", - "description": "The hostname of the Respository endpoint", - "examples": ["gitlab.com"] - }, - "path": { - "type": "string", - "description": "The path of the Repository endpoint", - "examples": ["itentialopensource/pre-built-automations"] - }, - "credentials": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "An access token used to make HTTP requests", - "examples": ["uTc_P4pnMAEsLbQHmyOt"] - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - } - } - }, - "/prebuilts-repository": { - "get": { - "summary": "Get all prebuilts", - "description": "Get all prebuilts from a repository.", - "tags": ["prebuilts-repository"], - "parameters": [ - { - "name": "page", - "in": "query", - "description": "The page number for the request return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "The page number for the request return. Used for pagination.", - "default": 1, - "minimum": 1, - "examples": [1, 3, 5] - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - }, - { - "name": "iap_version", - "in": "query", - "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.", - "required": false, - "schema": { - "type": "number", - "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.", - "examples": [2019.3, 2020.1] - } - }, - { - "name": "search", - "in": "query", - "description": "Search all available artifacts to find a match related to the provided query.", - "required": false, - "schema": { - "type": "string", - "description": "Search all available artifacts to find a match related to the provided query.", - "examples": ["device", "nso"] - } - }, - { - "name": "config", - "in": "query", - "description": "config", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_config" - } - }, - { - "name": "versionStatus", - "in": "query", - "description": "Filter the list of Pre-builts based on the available version of the Pre-built in comparison to the current version of IAP", - "required": false, - "schema": { - "type": "string", - "description": "Filter the list of Pre-builts based on the available version of the Pre-built in comparison to the current version of IAP", - "enum": ["latest", "current"] - } - } - ], - "operationId": "PrebuiltsRepository.getRepositoryPrebuilts", - "responses": { - "200": { - "description": "Contains an array of prebuilts and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "required": ["results", "total"], - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "versionStatus": { - "type": "object", - "properties": { - "status": { - "type": "string", - "examples": ["current"] - }, - "iap_version": { - "type": "string", - "examples": ["release/2020.1"] - } - } - }, - "installStatus": { - "type": "object", - "properties": { - "installable": { - "type": "boolean", - "enum": [true, false] - }, - "missingDependencies": { - "oneOf": [ - { - "type": "object", - "description": "A list of every dependency in the prebuilt that is missing from the running system." - }, - { - "type": "null" - } - ] - }, - "mismatchingDependencies": { - "oneOf": [ - { - "type": "object", - "description": "A list of every dependency in the prebuilt that has a version greater than the version of the service running on the system." - }, - { - "type": "null" - } - ] - } - } - }, - "availableUpdate": { - "oneOf": [ - { - "type": "boolean", - "enum": [true, false] - }, - { - "type": "null" - } - ] - }, - "name": { - "$ref": "#/components/schemas/iap_prebuilts-schema_name" - }, - "version": { - "$ref": "#/components/schemas/iap_prebuilts-schema_version" - }, - "description": { - "$ref": "#/components/schemas/iap_prebuilts-schema_description" - }, - "author": { - "$ref": "#/components/schemas/iap_prebuilts-schema_author" - }, - "published": { - "type": "string", - "examples": ["2020-04-09T17:44:30.215Z"], - "format": "date-time" - }, - "repository": { - "$ref": "#/components/schemas/iap_prebuilts-schema_repository" - }, - "license": { - "$ref": "#/components/schemas/iap_prebuilts-schema_license" - }, - "keywords": { - "$ref": "#/components/schemas/iap_prebuilts-schema_keywords" - }, - "IAPDependencies": { - "$ref": "#/components/schemas/iap_prebuilts-schema_IAPDependencies" - }, - "readme": { - "$ref": "#/components/schemas/iap_prebuilts-schema_readme" - }, - "download": { - "$ref": "#/components/schemas/iap_prebuilts-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - }, - "page": { - "type": "integer" - }, - "total-pages": { - "type": "integer" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "CookieAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ], - "BasicAuth": [ - "PrebuiltsRepository.admin", - "PrebuiltsRepository.apiread" - ] - } - ], - "deprecated": false - } - }, - "/sso/configs": { - "post": { - "summary": "Create an SSO configuration", - "description": "Create an SSO configuration", - "tags": ["sso"], - "parameters": [], - "operationId": "SSO.createSSOConfig", - "responses": { - "200": { - "description": "The result of the SSO config creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSO.admin"], - "CookieAuth": ["SSO.admin"], - "BasicAuth": ["SSO.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "config": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - } - } - } - }, - "get": { - "summary": "Get all SSO configurations", - "description": "Get all SSO configurations", - "tags": ["sso"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["GitHub"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "enum": [ - "name", - "samlEmailAttribute", - "samlUserNameAttribute", - "samlGroupsAttribute", - "samlFirstNameAttribute", - "ssoType" - ] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["Okta"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "enum": [ - "name", - "samlEmailAttribute", - "samlUserNameAttribute", - "samlGroupsAttribute", - "samlFirstNameAttribute", - "ssoType" - ] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["Okta"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "enum": [ - "name", - "samlEmailAttribute", - "samlUserNameAttribute", - "samlGroupsAttribute", - "samlFirstNameAttribute", - "ssoType" - ] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "SSO.getSSOConfigs", - "responses": { - "200": { - "description": "Contains an array of SSO configurations and the total in the response.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/iap_sso-schema" - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSO.admin", "SSO.apiread"], - "CookieAuth": ["SSO.admin", "SSO.apiread"], - "BasicAuth": ["SSO.admin", "SSO.apiread"] - } - ], - "deprecated": false - } - }, - "/sso/configs/{name}": { - "delete": { - "summary": "Delete an SSO configuration", - "description": "Delete an SSO configuration", - "tags": ["sso"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration to delete", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "SSO.deleteSSOConfig", - "responses": { - "200": { - "description": "The result of the SSO config deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSO.admin"], - "CookieAuth": ["SSO.admin"], - "BasicAuth": ["SSO.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a single SSO configuration", - "description": "Get a single SSO configuration", - "tags": ["sso"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration to get", - "required": true, - "schema": { - "title": "name", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "SSO.getSSOConfig", - "responses": { - "200": { - "description": "The SSO configuration document", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSO.admin", "SSO.apiread"], - "CookieAuth": ["SSO.admin", "SSO.apiread"], - "BasicAuth": ["SSO.admin", "SSO.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update an SSO configuration", - "description": "Update an SSO configuration", - "tags": ["sso"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration to delete", - "required": true, - "schema": { - "title": "result", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "SSO.updateSSOConfig", - "responses": { - "200": { - "description": "The result of the SSO config update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSO.admin"], - "CookieAuth": ["SSO.admin"], - "BasicAuth": ["SSO.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "config": { - "$ref": "#/components/schemas/iap_sso-schema" - } - } - } - } - } - } - } - }, - "/sso/configs/{name}/active": { - "post": { - "summary": "Activate an SSO configuration", - "description": "Activate an SSO configuration", - "tags": ["sso"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the SSO configuration to delete", - "required": true, - "schema": { - "title": "result", - "type": "string", - "examples": ["Auth0", "Okta"] - } - } - ], - "operationId": "SSO.setSSOConfigActive", - "responses": { - "200": { - "description": "The result of the SSO config update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSO.admin"], - "CookieAuth": ["SSO.admin"], - "BasicAuth": ["SSO.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "active": { - "title": "active", - "type": "boolean" - } - } - } - } - } - } - } - }, - "/prometheus_metrics": { - "get": { - "summary": "Get prometheus metrics.", - "description": "Builds and returns all prometheus metrics.", - "tags": ["prometheus_metrics"], - "parameters": [], - "operationId": "PrometheusMetrics.getPrometheusMetrics", - "responses": { - "200": { - "description": "result", - "content": { - "application/json": { - "schema": { - "title": "result", - "description": "Metrics to be ingested by prometheus.", - "type": "string" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false - } - }, - "/group-mappings": { - "get": { - "summary": "Get all group mappings.", - "description": "Get all group mappings", - "tags": ["group-mappings"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "expand", - "in": "query", - "description": "Sets the fields to expand", - "required": false, - "schema": { - "type": "string", - "title": "List of fields to get expanded data", - "description": "Sets the fields to expand", - "examples": ["iapGroups"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "SSOGroupMappings.getGroupMappings", - "responses": { - "200": { - "description": "The group mappings matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "$ref": "#/components/schemas/iap_mapping-schema" - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"], - "CookieAuth": [ - "SSOGroupMappings.admin", - "SSOGroupMappings.apiread" - ], - "BasicAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Create a group mapping.", - "description": "Create a group mapping", - "tags": ["group-mappings"], - "parameters": [], - "operationId": "SSOGroupMappings.createGroupMapping", - "responses": { - "200": { - "description": "Result of group mapping creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_mapping-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSOGroupMappings.admin"], - "CookieAuth": ["SSOGroupMappings.admin"], - "BasicAuth": ["SSOGroupMappings.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupMapping": { - "$ref": "#/components/schemas/iap_mapping-schema" - } - } - } - } - } - } - } - }, - "/group-mappings/{provenance}/{externalGroup}": { - "get": { - "summary": "Get an individual group mapping.", - "description": "Get an individual group mapping", - "tags": ["group-mappings"], - "parameters": [ - { - "name": "provenance", - "in": "path", - "description": "The provenance for the requested group mapping.", - "required": true, - "schema": { - "title": "provenance", - "type": "string" - } - }, - { - "name": "externalGroup", - "in": "path", - "description": "The name of the external group that is mapped.", - "required": true, - "schema": { - "title": "externalGroup", - "type": "string" - } - } - ], - "operationId": "SSOGroupMappings.getGroupMapping", - "responses": { - "200": { - "description": "The individual group mapping document.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_mapping-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"], - "CookieAuth": [ - "SSOGroupMappings.admin", - "SSOGroupMappings.apiread" - ], - "BasicAuth": ["SSOGroupMappings.admin", "SSOGroupMappings.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update a group mapping.", - "description": "Update a group mapping", - "tags": ["group-mappings"], - "parameters": [ - { - "name": "provenance", - "in": "path", - "description": "The provenance for the requested group mapping.", - "required": true, - "schema": { - "title": "provenance", - "type": "string" - } - }, - { - "name": "externalGroup", - "in": "path", - "description": "The individual group mapping to update.", - "required": true, - "schema": { - "title": "externalGroup", - "type": "string" - } - } - ], - "operationId": "SSOGroupMappings.updateGroupMapping", - "responses": { - "200": { - "description": "The output of the group mapping update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_mapping-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSOGroupMappings.admin"], - "CookieAuth": ["SSOGroupMappings.admin"], - "BasicAuth": ["SSOGroupMappings.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "iapGroups": { - "$ref": "#/components/schemas/iap_mapping-schema_iapGroups" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a group mapping.", - "description": "Delete a group mapping", - "tags": ["group-mappings"], - "parameters": [ - { - "name": "provenance", - "in": "path", - "description": "The provenance for the requested group mapping.", - "required": true, - "schema": { - "title": "provenance", - "type": "string" - } - }, - { - "name": "externalGroup", - "in": "path", - "description": "The individual group mapping to delete.", - "required": true, - "schema": { - "title": "externalGroup", - "type": "string" - } - } - ], - "operationId": "SSOGroupMappings.deleteGroupMapping", - "responses": { - "200": { - "description": "Result of group mapping deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["SSOGroupMappings.admin"], - "CookieAuth": ["SSOGroupMappings.admin"], - "BasicAuth": ["SSOGroupMappings.admin"] - } - ], - "deprecated": false - } - }, - "/git/{gitType}/repos/{repoPath}/branches/{branchName}/projects/{projectPath}": { - "get": { - "summary": "Retrieve a project from Git", - "description": "Retrieve a project from Git", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - }, - { - "name": "branchName", - "in": "path", - "description": "The name of the branch that is used.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_branchName" - } - }, - { - "name": "projectPath", - "in": "path", - "description": "The file path within a Git repository to a project file", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_projectPath" - } - } - ], - "operationId": "Git.getProject", - "responses": { - "200": { - "description": "The exact contents of the project file stored in Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - }, - "post": { - "summary": "Initialize a project in Git", - "description": "Initialize a project in Git", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - }, - { - "name": "branchName", - "in": "path", - "description": "The name of the branch that is used.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_branchName" - } - }, - { - "name": "projectPath", - "in": "path", - "description": "The file path within a Git repository to a project file", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_projectPath" - } - }, - { - "name": "project", - "in": "path", - "description": "The project document being pushed to Git", - "required": true, - "schema": { - "title": "project", - "type": "object" - } - } - ], - "operationId": "Git.initProject", - "responses": { - "200": { - "description": "The result of initializing a project in Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully initialized project"] - }, - "data": { - "type": "object", - "description": "The project document pushed to Git" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "commitMessage": { - "$ref": "#/components/schemas/iap_git-common_commitMessage" - } - } - } - } - } - } - }, - "put": { - "summary": "Update a project in Git", - "description": "Update a project in Git", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - }, - { - "name": "branchName", - "in": "path", - "description": "The name of the branch that is used.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_branchName" - } - }, - { - "name": "projectPath", - "in": "path", - "description": "The file path within a Git repository to a project file", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_projectPath" - } - }, - { - "name": "project", - "in": "path", - "description": "The project document being pushed to Git", - "required": true, - "schema": { - "title": "project", - "type": "object" - } - } - ], - "operationId": "Git.updateProject", - "responses": { - "200": { - "description": "The result of updating a project in Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully updated project"] - }, - "data": { - "type": "object", - "description": "The project document pushed to Git" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "commitMessage": { - "$ref": "#/components/schemas/iap_git-common_commitMessage" - } - } - } - } - } - } - } - }, - "/git/{gitType}/repos/{repoPath}/branches": { - "post": { - "summary": "Create a new branch in a repository", - "description": "Create a new branch in a repository", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - } - ], - "operationId": "Git.createBranch", - "responses": { - "200": { - "description": "The result of creating a branch", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully created branch: exampleBranch"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "originBranch": { - "$ref": "#/components/schemas/iap_git-common_branchName" - }, - "newBranch": { - "$ref": "#/components/schemas/iap_git-common_branchName" - } - } - } - } - } - } - }, - "get": { - "summary": "List the available branches for a repository", - "description": "List the available branches for a repository", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - } - ], - "operationId": "Git.listBranches", - "responses": { - "200": { - "description": "The result of retrieving a list of branches from Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the branch", - "type": "string", - "examples": ["main"] - }, - "protected": { - "description": "Whether or not the branch is protected", - "type": "boolean" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false - } - }, - "/git/{gitType}/repos/{repoPath}": { - "post": { - "summary": "Create a new repository in Git for storing projects", - "description": "Create a new repository in Git for storing projects", - "tags": ["git"], - "parameters": [ - { - "name": "gitType", - "in": "path", - "description": "The name of the Git provider that is used", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_type" - } - }, - { - "name": "repoPath", - "in": "path", - "description": "The path in Git to the repository", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_git-common_repoPath" - } - } - ], - "operationId": "Git.createRepo", - "responses": { - "200": { - "description": "The result of creating a repository in Git", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": [ - "`Successfully created repository: ExampleRepo" - ] - }, - "data": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The full path to the repository in Git", - "examples": [ - "group1/group2/ExampleRepo", - "exampleOrg/ExampleRepo" - ] - }, - "default_branch": { - "type": "string", - "description": "The default branch created for the repository", - "examples": ["main"] - }, - "visibility": { - "type": "string", - "description": "The visibility of the repository", - "examples": ["private"] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [], - "CookieAuth": [], - "BasicAuth": [] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repoName": { - "title": "repoName", - "type": "string", - "examples": ["RepositoryName"] - } - } - } - } - } - } - } - }, - "/profiles": { - "post": { - "summary": "Creates a new profile", - "description": "Create a new profile in IAP.", - "tags": ["profiles"], - "parameters": [], - "operationId": "Profiles.createProfile", - "responses": { - "200": { - "description": "The output of the profile creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "uiProps": { - "$ref": "#/components/schemas/iap_profiles-schema_uiProps" - }, - "authenticationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" - }, - "expressProps": { - "$ref": "#/components/schemas/iap_profiles-schema_expressProps" - }, - "loggerProps": { - "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" - }, - "redisProps": { - "$ref": "#/components/schemas/iap_profiles-schema_redisProps" - }, - "auditProps": { - "$ref": "#/components/schemas/iap_profiles-schema_auditProps" - }, - "pathProps": { - "$ref": "#/components/schemas/iap_profiles-schema_pathProps" - }, - "alarmProps": { - "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" - }, - "id": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - }, - "services": { - "$ref": "#/components/schemas/iap_profiles-schema_services" - }, - "description": { - "$ref": "#/components/schemas/iap_profiles-schema_description" - }, - "adapterStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" - }, - "systemProps": { - "$ref": "#/components/schemas/iap_profiles-schema_systemProps" - }, - "integrationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" - }, - "retryStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" - }, - "serviceDirectory": { - "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" - } - }, - "required": ["id"] - } - } - } - } - } - } - }, - "get": { - "summary": "Get all profiles.", - "description": "Get all the profiles in IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "type": "string", - "examples": ["profile1"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string", - "examples": ["id"] - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "string", - "examples": ["profile1"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "equalsField", - "required": false, - "schema": { - "type": "string", - "examples": ["id"] - } - }, - { - "name": "startsWith", - "in": "query", - "description": "startsWith", - "required": false, - "schema": { - "type": "string", - "examples": ["profile"] - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "startsWithField", - "required": false, - "schema": { - "type": "string", - "examples": ["id"] - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "Profiles.getProfiles", - "responses": { - "200": { - "description": "Contains the data of a profile.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - } - }, - "profile": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Profiles.admin", "Profiles.apiread"], - "CookieAuth": ["Profiles.admin", "Profiles.apiread"], - "BasicAuth": ["Profiles.admin", "Profiles.apiread"] - } - ], - "deprecated": false - } - }, - "/profiles/import": { - "post": { - "summary": "Import a new profile", - "description": "Import a new profile in IAP.", - "tags": ["profiles"], - "parameters": [], - "operationId": "Profiles.importProfile", - "responses": { - "200": { - "description": "The output of the profile import process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "uiProps": { - "$ref": "#/components/schemas/iap_profiles-schema_uiProps" - }, - "authenticationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" - }, - "expressProps": { - "$ref": "#/components/schemas/iap_profiles-schema_expressProps" - }, - "loggerProps": { - "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" - }, - "redisProps": { - "$ref": "#/components/schemas/iap_profiles-schema_redisProps" - }, - "auditProps": { - "$ref": "#/components/schemas/iap_profiles-schema_auditProps" - }, - "pathProps": { - "$ref": "#/components/schemas/iap_profiles-schema_pathProps" - }, - "alarmProps": { - "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" - }, - "id": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - }, - "services": { - "$ref": "#/components/schemas/iap_profiles-schema_services" - }, - "description": { - "$ref": "#/components/schemas/iap_profiles-schema_description" - }, - "adapterStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" - }, - "systemProps": { - "$ref": "#/components/schemas/iap_profiles-schema_systemProps" - }, - "integrationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" - }, - "retryStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" - }, - "serviceDirectory": { - "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" - }, - "migrationVersion": { - "type": "integer", - "minimum": 0 - } - }, - "required": ["id"] - } - } - } - } - } - } - } - }, - "/profiles/{id}": { - "delete": { - "summary": "Delete a profile.", - "description": "Delete a profile from IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.deleteProfile", - "responses": { - "200": { - "description": "The output of the profile deletion process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get a single profile.", - "description": "Get a single profile in the current IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.getProfile", - "responses": { - "200": { - "description": "Contains the metadata and data of a profile.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "isActive": { - "$ref": "#/components/schemas/iap_common-schema_isActive" - }, - "activeSync": { - "$ref": "#/components/schemas/iap_common-schema_activeSync" - } - } - }, - "profile": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Profiles.admin", "Profiles.apiread"], - "CookieAuth": ["Profiles.admin", "Profiles.apiread"], - "BasicAuth": ["Profiles.admin", "Profiles.apiread"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates a profile.", - "description": "Update a profile in IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.updateProfile", - "responses": { - "200": { - "description": "The output of the update process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "properties": { - "title": "properties", - "type": "object", - "properties": { - "uiProps": { - "$ref": "#/components/schemas/iap_profiles-schema_uiProps" - }, - "authenticationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_authenticationProps" - }, - "expressProps": { - "$ref": "#/components/schemas/iap_profiles-schema_expressProps" - }, - "loggerProps": { - "$ref": "#/components/schemas/iap_profiles-schema_loggerProps" - }, - "redisProps": { - "$ref": "#/components/schemas/iap_profiles-schema_redisProps" - }, - "auditProps": { - "$ref": "#/components/schemas/iap_profiles-schema_auditProps" - }, - "pathProps": { - "$ref": "#/components/schemas/iap_profiles-schema_pathProps" - }, - "alarmProps": { - "$ref": "#/components/schemas/iap_profiles-schema_alarmProps" - }, - "id": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - }, - "services": { - "$ref": "#/components/schemas/iap_profiles-schema_services" - }, - "description": { - "$ref": "#/components/schemas/iap_profiles-schema_description" - }, - "adapterStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_adapterStrategy" - }, - "systemProps": { - "$ref": "#/components/schemas/iap_profiles-schema_systemProps" - }, - "integrationProps": { - "$ref": "#/components/schemas/iap_profiles-schema_integrationProps" - }, - "retryStrategy": { - "$ref": "#/components/schemas/iap_profiles-schema_retryStrategy" - }, - "serviceDirectory": { - "$ref": "#/components/schemas/iap_profiles-schema_serviceDirectory" - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/profiles/{id}/export": { - "get": { - "summary": "Export a single profile.", - "description": "Exports a single profile in the current IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.exportProfile", - "responses": { - "200": { - "description": "Contains the metadata and data of a profile.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Profiles.admin", "Profiles.apiread"], - "CookieAuth": ["Profiles.admin", "Profiles.apiread"], - "BasicAuth": ["Profiles.admin", "Profiles.apiread"] - } - ], - "deprecated": false - } - }, - "/profiles/{id}/active": { - "put": { - "summary": "Switch the active profile.", - "description": "Switch the active profile in the current IAP.", - "tags": ["profiles"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Contains the id for the selected profile.", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_profiles-schema_id" - } - } - ], - "operationId": "Profiles.switchActiveProfile", - "responses": { - "200": { - "description": "The output of the profile creation process.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Profiles.admin"], - "CookieAuth": ["Profiles.admin"], - "BasicAuth": ["Profiles.admin"] - } - ], - "deprecated": true - } - }, - "/oauth/serviceAccounts": { - "post": { - "summary": "Create a service account in the database.", - "description": "Create a service account in the database.", - "tags": ["oauth"], - "parameters": [], - "operationId": "OAuth.createServiceAccount", - "responses": { - "200": { - "description": "result", - "content": { - "application/json": { - "schema": { - "title": "result", - "description": "The client credentials for a new service account", - "type": "object", - "properties": { - "client_id": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - }, - "client_secret": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountData": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - } - } - } - } - } - }, - "get": { - "summary": "Get service accounts from the database.", - "description": "Get service accounts from the database.", - "tags": ["oauth"], - "parameters": [ - { - "name": "multiContains", - "in": "query", - "description": "multiContains", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - }, - { - "name": "multiEquals", - "in": "query", - "description": "multiEquals", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - }, - { - "name": "multiStartsWith", - "in": "query", - "description": "multiStartsWith", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_limit" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_sort" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/iap_common-schema_order" - } - } - ], - "operationId": "OAuth.getServiceAccounts", - "responses": { - "200": { - "description": "The service accounts matching the specified query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/iap_service-accounts-schema_name" - }, - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - }, - "client_id": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" - }, - "createdBy": { - "$ref": "#/components/schemas/iap_service-accounts-schema_modifiedByDereferenced" - }, - "updated": { - "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" - }, - "updatedBy": { - "$ref": "#/components/schemas/iap_service-accounts-schema_modifiedByDereferenced" - }, - "secretUpdated": { - "$ref": "#/components/schemas/iap_service-accounts-schema_timestamp" - } - } - } - } - } - }, - "total": { - "$ref": "#/components/schemas/iap_common-schema_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false - } - }, - "/oauth/serviceAccounts/{client_id}": { - "patch": { - "summary": "Updates a service account in the database.", - "description": "Updates a service account in the database.", - "tags": ["oauth"], - "parameters": [ - { - "name": "client_id", - "in": "path", - "description": "The clientId for the service account", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - } - } - ], - "operationId": "OAuth.updateServiceAccount", - "responses": { - "200": { - "description": "The output of the service account update.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - }, - "data": { - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "updates": { - "title": "updates", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/iap_service-accounts-schema_description" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Deletes a service account in the database.", - "description": "Deletes a service account in the database.", - "tags": ["oauth"], - "parameters": [ - { - "name": "client_id", - "in": "path", - "description": "The clientId for the service account", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - } - } - ], - "operationId": "OAuth.deleteServiceAccount", - "responses": { - "200": { - "description": "Result of service account deletion process", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/iap_common-schema_status" - }, - "message": { - "$ref": "#/components/schemas/iap_common-schema_message" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false - } - }, - "/oauth/serviceAccounts/{client_id}/regenerate": { - "patch": { - "summary": "Regenerates the client_secret and returns the new value", - "description": "Regenerates the client_secret and returns the new value", - "tags": ["oauth"], - "parameters": [ - { - "name": "client_id", - "in": "path", - "description": "The clientId for the service account", - "required": true, - "schema": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - } - } - ], - "operationId": "OAuth.regenerateSecret", - "responses": { - "200": { - "description": "The new client credentials for a service account", - "content": { - "application/json": { - "schema": { - "title": "result", - "description": "The updated client credentials for an existing service account", - "type": "object", - "properties": { - "client_id": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - }, - "client_secret": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["OAuth.admin"], - "CookieAuth": ["OAuth.admin"], - "BasicAuth": ["OAuth.admin"] - } - ], - "deprecated": false - } - }, - "/oauth/token": { - "post": { - "summary": "Retrieve a JWT from a client's credentials", - "description": "Retrieve a JWT from a client's credentials", - "tags": ["oauth"], - "parameters": [], - "operationId": "OAuth.machineAuthentication", - "responses": { - "200": { - "description": "result", - "content": { - "application/json": { - "schema": { - "title": "result", - "description": "A result containing the JWT providing the user access to IAP for a set amount of time", - "type": "object", - "properties": { - "access_token": { - "description": "The JWT providing the user access to IAP", - "type": "string" - }, - "token_type": { - "description": "The type of token provided", - "type": "string", - "enum": ["bearer"] - }, - "expires_in": { - "description": "The amount of time until the JWT expires", - "type": "integer", - "enum": [3600] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "client_id": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientId" - }, - "client_secret": { - "$ref": "#/components/schemas/iap_service-accounts-schema_clientSecret" - }, - "grant_type": { - "type": "string", - "enum": ["client_credentials"] - } - } - } - } - } - } - } - }, - "/transformations/": { - "get": { - "summary": "Search for transformation documents.", - "description": "Search for transformation documents.", - "tags": ["transformations"], - "parameters": [ - { - "name": "incoming", - "in": "query", - "description": "incoming", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "outgoing", - "in": "query", - "description": "outgoing", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "schema", - "in": "query", - "description": "schema", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "contains", - "in": "query", - "description": "contains", - "required": false, - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - } - }, - { - "name": "containsField", - "in": "query", - "description": "containsField", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "equals", - "in": "query", - "description": "equals", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "not", - "in": "query", - "description": "not", - "required": false, - "schema": { - "type": "object" - } - }, - { - "name": "expand", - "in": "query", - "description": "expand", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "type": "number" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "type": "number" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "type": "number" - } - }, - { - "name": "exclude-project-members", - "in": "query", - "description": "exclude-project-members", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "operationId": "Jst.searchTransformations", - "responses": { - "200": { - "description": "Transformation documents.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Creates a single transformation.", - "description": "Creates a single transformation.", - "tags": ["transformations"], - "parameters": [], - "operationId": "Jst.createTransformation", - "responses": { - "200": { - "description": "Created transformation document.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "transformation", - "content": { - "application/json": { - "schema": { - "title": "transformation", - "type": "object" - } - } - } - } - } - }, - "/transformations/import": { - "post": { - "summary": "Imports a single transformation.", - "description": "Imports a single transformation.", - "tags": ["transformations"], - "parameters": [], - "operationId": "Jst.importTransformation", - "responses": { - "200": { - "description": "Imported transformation document.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "transformation", - "content": { - "application/json": { - "schema": { - "title": "transformation", - "type": "object" - } - } - } - } - } - }, - "/transformations/{id}": { - "get": { - "summary": "Gets transformation document by id.", - "description": "Gets transformation document by id.", - "tags": ["transformations"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "Jst.getTransformation", - "responses": { - "200": { - "description": "Transformation document.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates a single transformation.", - "description": "Updates a single transformation.", - "tags": ["transformations"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "Jst.updateTransformation", - "responses": { - "200": { - "description": "Updated transformation document.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "transformation", - "content": { - "application/json": { - "schema": { - "title": "transformation", - "type": "object" - } - } - } - } - }, - "delete": { - "summary": "Deletes a single transformation document.", - "description": "Deletes a single transformation document.", - "tags": ["transformations"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "Jst.deleteTransformation", - "responses": { - "200": { - "description": "Deletion result.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Runs a transformation.", - "description": "Runs a transformation.", - "tags": ["transformations"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "Jst.runTransformation", - "responses": { - "200": { - "description": "Transformation run result.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "CookieAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ], - "BasicAuth": [ - "Jst.admin", - "Jst.other", - "Jst.readonly", - "Jst.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "incoming": { - "title": "incoming", - "type": "object" - }, - "options": { - "title": "options", - "type": "object" - } - } - } - } - } - } - } - }, - "/formbuilder/saveForm": { - "post": { - "summary": "Save a Generated Form", - "description": "Save a generated form with its data.", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.saveForm", - "responses": { - "200": { - "description": "Status of save form", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "formData": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - } - } - } - } - }, - "/formbuilder/getFormByName/{form_name}": { - "get": { - "summary": "Get Details of Form by Name", - "description": "Get details for a specific form by name", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "form_name", - "in": "path", - "description": "Form name", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.getFormByName", - "responses": { - "200": { - "description": "Forms details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/preserveFormData": { - "post": { - "summary": "Preserve incoming form data format", - "description": "Find and revert containers object/array mutation", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.preserveFormData", - "responses": { - "200": { - "description": "Forms details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "form_name": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - }, - "data": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - } - } - } - } - }, - "/formbuilder/getForm/{form_id}": { - "get": { - "summary": "Get Details of Form by ID", - "description": "Get details for a specific form from by ID", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "form_id", - "in": "path", - "description": "Form ID", - "required": true, - "schema": { - "title": "form_id", - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - } - } - ], - "operationId": "FormBuilder.getForm", - "responses": { - "200": { - "description": "Forms details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/listForms": { - "get": { - "summary": "List All Form Names", - "description": "List the names of all available forms", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.listForms", - "responses": { - "200": { - "description": "Array of form names", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "array", - "items": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - }, - "uniqueItems": true - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/forms/search": { - "post": { - "summary": "Search Forms", - "description": "Search forms with options", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.searchForms", - "responses": { - "200": { - "description": "Array of objects containing forms", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "array", - "items": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "filter": { - "type": "object", - "examples": [ - { - "name": "form_example_1" - } - ] - }, - "startAt": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "maxResults": { - "type": "integer", - "minimum": 0, - "maximum": 100, - "examples": [10] - }, - "sort": { - "type": "object", - "examples": [ - { - "name": 1 - } - ] - }, - "fields": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "children", - "elements", - "createddBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - "examples": [ - [ - "name", - "children", - "elements", - "createddBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - ], - "uniqueItems": true - }, - "expand": { - "type": "array", - "items": { - "type": "string", - "enum": ["createdBy", "lastUpdatedBy"] - }, - "examples": [["createdBy", "lastUpdatedBy"]], - "uniqueItems": true - } - } - } - } - } - } - } - } - } - }, - "/formbuilder/fetchData": { - "post": { - "summary": "Get Service Instance Data", - "description": "Returns service related data", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.fetchData", - "responses": { - "200": { - "description": "Json object of service instance", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "examples": [ - { - "/ncs:services/test:choices": [ - { - "service-name": "service_name_1", - "choice-a": "1" - } - ] - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "FormBuilder.admin", - "FormBuilder.apiwrite", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiwrite", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiwrite", - "FormBuilder.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "service": { - "title": "service", - "type": "string", - "examples": ["/ncs:devices/ncs:device"] - }, - "instance_key": { - "title": "instance_key", - "type": "string", - "examples": ["ncs:name"] - }, - "val": { - "title": "val", - "type": "string", - "examples": ["my_device_01"] - } - } - } - } - } - } - } - }, - "/formbuilder/getElementDefinition/{type}/{id}": { - "get": { - "summary": "Gets an Element Definition.", - "description": "Get the details about a particular element to be used in a form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "type", - "in": "path", - "description": "Element type", - "required": true, - "schema": { - "title": "type", - "type": "string", - "enum": ["service_model", "method"] - } - }, - { - "name": "id", - "in": "path", - "description": "Type ID", - "required": true, - "schema": { - "title": "id", - "type": "string", - "examples": ["/ncs:services/itential_test_devices:multidevice"] - } - } - ], - "operationId": "FormBuilder.getElementDefinition", - "responses": { - "200": { - "description": "Definition of the element", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "examples": [ - { - "children": [], - "type": "service", - "name": "service-name", - "properties": {}, - "key": "s-key", - "namespace": "", - "hosts": ["nso1", "nso2"] - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/listElements": { - "get": { - "summary": "Lists all Elements Usable in Forms", - "description": "Find all elements allowed to be added to a form", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.listElements", - "responses": { - "200": { - "description": "Array of objects containing elements", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_elements" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "CookieAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ], - "BasicAuth": [ - "FormBuilder.admin", - "FormBuilder.apiread", - "FormBuilder.operator" - ] - } - ], - "deprecated": false - } - }, - "/formbuilder/deleteForm/{id}": { - "post": { - "summary": "Delete a Form by ID", - "description": "Delete a form from the database by its ID", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Form ID", - "required": true, - "schema": { - "title": "id", - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - } - } - ], - "operationId": "FormBuilder.deleteForm", - "responses": { - "200": { - "description": "Status of delete", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] - } - ], - "deprecated": false - } - }, - "/formbuilder/forms/{name}/groups": { - "get": { - "summary": "List Groups for a Form", - "description": "List the groups that have access to a Form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.listFormGroups", - "responses": { - "200": { - "description": "List of Groups", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_groups" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["FormBuilder.apiread", "FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.apiread", "FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.apiread", "FormBuilder.authorization"] - } - ], - "deprecated": false - }, - "put": { - "summary": "Overwrite Groups for a Form", - "description": "Overwrite the list of groups that have access to a Form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.replaceFormGroups", - "responses": { - "200": { - "description": "Status of Overwrite", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.authorization"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "$ref": "#/components/schemas/formbuilder_formDocument_groups" - } - } - } - } - } - } - }, - "post": { - "summary": "Add Group to Form", - "description": "Add a group to the list of groups for a Form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.createFormGroupEntry", - "responses": { - "200": { - "description": "Status of Overwrite", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.authorization"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "$ref": "#/components/schemas/formbuilder_formDocument_ObjectId" - } - } - } - } - } - } - }, - "delete": { - "summary": "Remove all authorization restriction for a Form", - "description": "Clear all groups that can access a form, making it accessible to everyone", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - } - ], - "operationId": "FormBuilder.deleteFormGroups", - "responses": { - "200": { - "description": "Status of Delete", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.authorization"] - } - ], - "deprecated": false - } - }, - "/formbuilder/forms/{name}/groups/{group}": { - "delete": { - "summary": "Remove a Group from a Form", - "description": "Remove a group from the list of authorized groups for a Form", - "tags": ["formbuilder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Form", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - }, - { - "name": "group", - "in": "path", - "description": "A Group ID", - "required": true, - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument_ObjectId" - } - } - ], - "operationId": "FormBuilder.removeFormGroup", - "responses": { - "200": { - "description": "Status of Removal", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["FormBuilder.authorization"], - "CookieAuth": ["FormBuilder.authorization"], - "BasicAuth": ["FormBuilder.authorization"] - } - ], - "deprecated": false - } - }, - "/formbuilder/forms/export": { - "post": { - "summary": "Export Form", - "description": "Export a single Form", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.exportForm", - "responses": { - "200": { - "description": "Exported Form", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/formbuilder_formDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["FormBuilder.admin", "FormBuilder.apiread"], - "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiread"], - "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/formbuilder_formDocument_uuidv4" - }, - "name": { - "$ref": "#/components/schemas/formbuilder_formDocument_formName" - } - }, - "anyOf": [ - { - "required": ["_id"] - }, - { - "required": ["name"] - } - ], - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/formbuilder/forms/import": { - "post": { - "summary": "Import Form", - "description": "Import a single Form", - "tags": ["formbuilder"], - "parameters": [], - "operationId": "FormBuilder.importForm", - "responses": { - "200": { - "description": "Import status", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "CookieAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"], - "BasicAuth": ["FormBuilder.admin", "FormBuilder.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "form": { - "$ref": "#/components/schemas/formbuilder_formDocument" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "adapterMap": { - "type": "object" - } - } - } - } - } - } - } - } - } - }, - "/search/find": { - "post": { - "summary": "Search IAP", - "description": "Search through IAP for results from various collections that match your search term, as well as for results that have tags that match your search term.", - "tags": ["search"], - "parameters": [], - "operationId": "Search.find", - "responses": { - "200": { - "description": "Search results", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/search_searchResults" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Search.admin", "Search.apiwrite"], - "CookieAuth": ["Search.admin", "Search.apiwrite"], - "BasicAuth": ["Search.admin", "Search.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "text": { - "type": "string", - "examples": ["test"] - }, - "limit": { - "type": "integer", - "examples": [20] - }, - "skip": { - "type": "integer", - "examples": [5] - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/devices": { - "post": { - "summary": "Find Devices", - "description": "Gets a specific subset of devices for based on given options", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDevicesFiltered", - "responses": { - "200": { - "description": "Filtered/Sorted Devices", - "content": { - "application/json": { - "schema": { - "title": "devices", - "type": "object", - "properties": { - "entity": { - "const": "device" - }, - "total": { - "type": "integer", - "minimum": 0 - }, - "unique_device_count": { - "type": "integer", - "minimum": 0 - }, - "return_count": { - "type": "integer", - "minimum": 0 - }, - "start_index": { - "type": "integer", - "minimum": 0 - }, - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceDetails" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "start": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "limit": { - "type": "integer", - "minimum": 1, - "examples": [20] - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "address": { - "type": "string", - "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", - "examples": ["10.1.98.234"] - }, - "port": { - "type": "string", - "pattern": "^[0-9]+$", - "examples": ["22"] - } - } - }, - "sort": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "enum": [-1, 1] - }, - "address": { - "enum": [-1, 1] - }, - "port": { - "enum": [-1, 1] - } - } - } - }, - "order": { - "type": "string", - "enum": ["ascending", "descending"] - }, - "adapterType": { - "type": "array", - "items": { - "type": "string", - "examples": ["NSO", "AnsibleManager"] - }, - "uniqueItems": true - }, - "adapterId": { - "type": "array", - "items": { - "type": "string", - "examples": ["ansible-us-east"], - "uniqueItems": true - } - }, - "exactMatch": { - "type": "boolean", - "description": "boolean that indicates if an exact result will be returned or not", - "enum": [true, false] - } - }, - "required": ["limit"] - } - } - } - } - } - } - } - }, - "/configuration_manager/cache/devices/ostype": { - "post": { - "summary": "Fetches OS Types to store into the cache.", - "description": "Gathers all the device OS Types in the current evnironment and stores them in the cache.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.cacheOSTypes", - "responses": { - "200": { - "description": "Cached OS Type data.", - "content": { - "application/json": { - "schema": { - "title": "cacheData", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "interval": { - "type": "integer", - "description": "Determines how often (in hours) the OS Types are cached.", - "examples": [48] - } - } - } - } - } - } - } - } - }, - "get": { - "summary": "Fetches the OSTypes stored in the cache.", - "description": "Gathers all the device OS Types in the current cache.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getCachedOSTypes", - "responses": { - "200": { - "description": "Cached OS Type data.", - "content": { - "application/json": { - "schema": { - "title": "cacheData", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Deletes the cache for os types.", - "description": "Removes the cache in the database for os type values.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteOSTypeCache", - "responses": { - "200": { - "description": "Deletion response.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "string", - "examples": [ - "Successfully deleted the cache for device os types." - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/pins": { - "delete": { - "summary": "Deletes pinned items.", - "description": "Deletes the pinned items permanently from the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deletePins", - "responses": { - "200": { - "description": "Result of the deletion.", - "content": { - "application/json": { - "schema": { - "title": "result", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pinTargets": { - "title": "pinTargets", - "type": "array", - "items": {} - }, - "sourceItem": { - "title": "sourceItem", - "type": "string" - } - } - } - } - } - } - }, - "post": { - "summary": "Add an item to pins or remove from if it already exists", - "description": "Add an item to pins or remove from if it already exists", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.handlePin", - "responses": { - "200": { - "description": "Pin object with details.", - "content": { - "application/json": { - "schema": { - "title": "pin", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "properties": { - "sourceItem": { - "type": "string", - "example": "cm_device_groups" - }, - "target": { - "type": "string", - "example": "CSR_Devices_Group" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/pins/fetch": { - "post": { - "summary": "Get a list of pinned items.", - "description": "Fetches a list of pinned items based on the input parameters. The list of pinned items are specific to the current user or actor. This api supports pagination.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getPins", - "responses": { - "200": { - "description": "Returns the list of pins and the total count.", - "content": { - "application/json": { - "schema": { - "title": "pins", - "type": "object", - "properties": { - "pins": { - "type": "array", - "items": { - "type": "object" - } - }, - "count": { - "type": "number", - "example": "10" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "properties": { - "filter": { - "type": "object", - "example": "{ sourceItem: 'cm_gc' }" - }, - "start": { - "type": "number", - "example": "0" - }, - "limit": { - "type": "number", - "example": "10" - }, - "projection": { - "type": "object", - "example": "{ users: 0 }" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/ismaintenance": { - "get": { - "summary": "Checks if the current version of CM is maintenance or not.", - "description": "Returns a boolean reflecting whether the current Configuration Manager bundle is a maintenance bundle.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.isMaintenance", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/jinja2": { - "post": { - "summary": "Renders a jinja2 template.", - "description": "Takes a jinja2 template a renders output text.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.renderJinja2", - "responses": { - "200": { - "description": "Returns the list of pins and the total count.", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "string", - "examples": ["this is a jinja2 template"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "title": "template", - "type": "string", - "example": "this is a {{ varName }} template" - }, - "variables": { - "title": "variables", - "properties": {} - }, - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/adaptertasks/search": { - "post": { - "summary": "Get data for all adapters with tasks.", - "description": "Fetch method/task metadata for all adapters that have it.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getAdapterTasks", - "responses": { - "200": { - "description": "Output of adapters' metadata.", - "content": { - "application/json": { - "schema": { - "title": "adapterData", - "type": "object", - "properties": { - "adapterTasks": { - "type": "object", - "properties": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/adaptertasks": { - "post": { - "summary": "Get data for a specific adapter task.", - "description": "Fetch method/task metadata for an adapter task.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getAdapterTask", - "responses": { - "200": { - "description": "Output of adapter task's metadata.", - "content": { - "application/json": { - "schema": { - "title": "taskData", - "type": "object", - "properties": { - "adapterTasks": { - "type": "object", - "properties": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskName": { - "title": "taskName", - "type": "string", - "examples": ["getConfig", "getServiceModel"] - }, - "origin": { - "title": "origin", - "type": "string", - "examples": ["nso52", "localAAA"] - }, - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/instance": { - "post": { - "summary": "Create a task instance.", - "description": "Create an instance of a task and save it to the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createTaskInstance", - "responses": { - "200": { - "description": "Response of whether the insertion operation failed or succeeded.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "instanceName": { - "title": "instanceName", - "type": "string" - }, - "origin": { - "title": "origin", - "type": "string", - "examples": ["nso52", "localAAA"] - }, - "taskName": { - "title": "taskName", - "type": "string", - "examples": ["getConfig", "getServiceModel"] - }, - "treeId": { - "title": "treeId", - "type": "string", - "examples": ["5f21c92ba6abf82bf5041783"] - }, - "taskParams": { - "title": "taskParams", - "properties": {} - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - }, - "put": { - "summary": "Update a task instance.", - "description": "Update an instance of a task and save it to the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateTaskInstance", - "responses": { - "200": { - "description": "Response of whether the update operation failed or succeeded.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskId": { - "title": "taskId", - "type": "string" - }, - "treeId": { - "title": "treeId", - "type": "string" - }, - "taskParams": { - "title": "taskParams", - "type": "object", - "properties": {} - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete task instance(s).", - "description": "Delete task instance(s) from the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteTaskInstances", - "responses": { - "200": { - "description": "Response of whether the delete operation failed or succeeded.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskIds": { - "title": "taskIds", - "type": "array", - "properties": {}, - "items": {} - }, - "treeId": { - "title": "treeId", - "type": "string" - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/instances": { - "post": { - "summary": "Get task instance(s).", - "description": "Get instance(s) of a task.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getTaskInstances", - "responses": { - "200": { - "description": "Response of whether the get operation failed or succeded (with data).", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "title": "treeId", - "type": "string", - "examples": ["5f21c92ba6abf82bf5041783"] - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "filter": { - "type": "object", - "example": "{ 'instanceName': 'some task instance 1' }" - }, - "nodePath": { - "type": "string", - "example": "base" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/instances/search": { - "post": { - "summary": "Search for task instance(s).", - "description": "Search for task instance(s) using varies options parameters.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchTaskInstances", - "responses": { - "200": { - "description": "Response of whether the get operation failed or succeded (with data).", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "filter": { - "type": "object", - "example": "{ 'instanceName': 'some task instance 1' }" - }, - "nodePath": { - "type": "string", - "example": "base" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/instance/run": { - "post": { - "summary": "Run a task instance.", - "description": "Run an instance of a task and save it to the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runTaskInstance", - "responses": { - "200": { - "description": "Data returned by the execution of the task instance..", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskId": { - "title": "taskId", - "type": "string" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/tasks/run": { - "post": { - "summary": "Run an adapter task.", - "description": "Run an adapter task.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runAdapterTask", - "responses": { - "200": { - "description": "Data returned by the exection of the adapter task.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "origin": { - "title": "origin", - "type": "string" - }, - "taskName": { - "title": "taskName", - "type": "string" - }, - "args": { - "title": "args", - "type": "object", - "properties": {} - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/{name}": { - "get": { - "summary": "Get Device Details", - "description": "Get detailed information for a specific device, based on its device name", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.getDevice", - "responses": { - "200": { - "description": "Device's details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceDetails" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/devices/{name}/configuration": { - "get": { - "summary": "Get Device Configuration", - "description": "Get configuration for a specific device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.getDeviceConfig", - "responses": { - "200": { - "description": "Configuration for a specific device", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/devices/{name}/configuration/{format}": { - "get": { - "summary": "Get formatted device config", - "description": "Get device configuration in a given format.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - { - "name": "format", - "in": "path", - "description": "Supported formats by NSO (xml, native, json) & Automation Gateway (native).", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfigurationFormat" - } - } - ], - "operationId": "ConfigurationManager.getDeviceConfigFormat", - "responses": { - "200": { - "description": "Configuration for a specific device", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": true - } - }, - "/configuration_manager/devices/backups": { - "post": { - "summary": "Backup device configuration", - "description": "Backup device configuration in mongo", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.backUpDevice", - "responses": { - "200": { - "description": "Status of backup operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "Device {deviceName} backed up successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backupDescription" - }, - "notes": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backupNotes" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/import/backups": { - "post": { - "summary": "Import backup documents", - "description": "Insert backup documents into the ucm_configs collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importBackup", - "responses": { - "200": { - "description": "Status of backup import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 device backups imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "backups": { - "title": "backups", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backup" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/import/groups": { - "post": { - "summary": "Import device group documents", - "description": "Insert device group documents into the device_groups collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importGroup", - "responses": { - "200": { - "description": "Status of group import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 device groups imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "title": "groups", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_groupDetails" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/backups": { - "post": { - "summary": "Get Device Backup List", - "description": "Fetches backups, requires an options payload. An empty option payload will return the first 25 documents", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getBackups", - "responses": { - "200": { - "description": "List of all backups and the total", - "content": { - "application/json": { - "schema": { - "title": "backups", - "type": "object", - "properties": { - "total": { - "type": "integer", - "minimum": 0 - }, - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backup" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "start": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "limit": { - "type": "integer", - "minimum": 1, - "examples": [20] - }, - "regex": { - "type": "boolean" - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "dateRange": { - "type": "array", - "description": "An array containing the start and end date. Index 0 = start date, index 1 = end date.", - "items": {} - }, - "sort": { - "type": "object", - "properties": { - "name": { - "enum": [-1, 1] - }, - "date": { - "enum": [-1, 1] - } - } - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete one or more device backups by Id", - "description": "This API call will delete device backups based on given Ids", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDeviceBackups", - "responses": { - "200": { - "description": "Status with the number of device backups deleted", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "deleted": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "backupIds": { - "title": "backupIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/backups/list": { - "get": { - "summary": "Gets a list of all backed up devices", - "description": "Returns a list of devices that have one or more backups", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getBackedUpDevices", - "responses": { - "200": { - "description": "List of devices with backups", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/backups/{id}": { - "get": { - "summary": "Get Device Backup", - "description": "Retrieves single backup document by id", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Backup's id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getDeviceBackupById", - "responses": { - "200": { - "description": "JSON object that contains the backed up configuration", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backup" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update a device backup by Id", - "description": "This API call will update the metadata of a device backup by ID", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Backup Id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateDeviceBackupById", - "responses": { - "200": { - "description": "Status of the device backup updated", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "updated": { - "type": "integer", - "enum": [0, 1] - } - }, - "required": ["status", "updated"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backupDescription" - }, - "notes": { - "$ref": "#/components/schemas/configuration_manager_deviceData_backupNotes" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/name/devicegroups": { - "get": { - "summary": "Get Device Group by Name", - "description": "Retrieves a single group document by name", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDeviceGroupByName", - "responses": { - "200": { - "description": "JSON object that contains the device group details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupName": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - } - } - } - } - } - } - } - }, - "/configuration_manager/groups/device/{deviceName}": { - "get": { - "summary": "Gets device groups for a device", - "description": "Finds all the device groups that contain the specified device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.getGroupsForDevice", - "responses": { - "200": { - "description": "List of device groups found", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/devices/{name}/isAlive": { - "get": { - "summary": "Check if device is connected", - "description": "Get connection status of device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.isAlive", - "responses": { - "200": { - "description": "Status of device connection", - "content": { - "application/json": { - "schema": { - "title": "status", - "oneOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/devicegroup": { - "post": { - "summary": "Creates a device group", - "description": "Creates a new device group in pronghorn", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createDeviceGroup", - "responses": { - "200": { - "description": "Result of creating a new device group", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_createGroupResponseWithName" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupName": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - }, - "groupDescription": { - "$ref": "#/components/schemas/configuration_manager_common_standardDescription" - }, - "deviceNames": { - "$ref": "#/components/schemas/configuration_manager_common_multiElementString" - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups": { - "get": { - "summary": "Get all Device Groups", - "description": "Gets a list of all known device groups", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDeviceGroups", - "responses": { - "200": { - "description": "List of device groups found", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Delete device groups", - "description": "Delete specified device groups", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDeviceGroups", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_deleteGroupResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupIds": { - "title": "groupIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/search": { - "post": { - "summary": "Search all Device Groups", - "description": "Gets a list of all device groups that match the search criteria", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchDeviceGroups", - "responses": { - "200": { - "description": "List of device groups that match the search criteria", - "content": { - "application/json": { - "schema": { - "title": "deviceGroups", - "type": "object", - "properties": { - "totalCount": { - "type": "number" - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "s": { - "title": "s", - "type": "string" - }, - "start": { - "title": "start", - "type": "number" - }, - "limit": { - "title": "limit", - "type": "number" - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/query": { - "post": { - "summary": "Search device groups", - "description": "Returns device groups that match the specified input", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchGroups", - "responses": { - "200": { - "description": "List of device groups that match the search criteria", - "content": { - "application/json": { - "schema": { - "title": "deviceGroups", - "type": "object", - "properties": { - "totalCount": { - "type": "number" - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "start": { - "title": "start", - "type": "number" - }, - "limit": { - "title": "limit", - "type": "number" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "regex": { - "type": "boolean", - "description": "Enables global regex/substring search." - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/{id}": { - "get": { - "summary": "Get Device Group by ID", - "description": "Get Device Group by ID", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Group Id or Group Name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getDeviceGroupById", - "responses": { - "200": { - "description": "JSON object that contains the device group details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update device groups", - "description": "Updates the device group's details and devices.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Group Id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateDeviceGroups", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "details": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupDetails" - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/{id}/devices": { - "delete": { - "summary": "Removes devices from a group", - "description": "Removes devices from a device group", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "ConfigurationManager.removeDevicesFromGroup", - "responses": { - "200": { - "description": "Result of removing devices", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "devices": { - "title": "devices", - "type": "array", - "properties": {}, - "items": {} - } - } - } - } - } - } - }, - "post": { - "summary": "Adds new devices to the group", - "description": "Adds devices to a group", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "ConfigurationManager.addDevicesToGroup", - "responses": { - "200": { - "description": "Result of adding new devices to the group", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "devices": { - "title": "devices", - "type": "array", - "properties": {}, - "items": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/name/deviceGroups": { - "delete": { - "summary": "Delete device groups", - "description": "Delete specified device groups", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDeviceGroupsByName", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_deleteGroupResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupNames": { - "title": "groupNames", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/deviceGroups/devices": { - "post": { - "summary": "Add device(s) to a group", - "description": "This API call will add device(s) to a device group", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.addDevicesToGroupByName", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupName": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - }, - "deviceNames": { - "$ref": "#/components/schemas/configuration_manager_common_multiElementString" - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete device(s) from a group", - "description": "This API call will delete device(s) from a device group", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDevicesFromGroup", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceGroupDocument_updateGroupsResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupName": { - "$ref": "#/components/schemas/configuration_manager_common_standardName" - }, - "deviceNames": { - "$ref": "#/components/schemas/configuration_manager_common_multiElementString" - } - } - } - } - } - } - } - }, - "/configuration_manager/lookup_diff": { - "put": { - "summary": "Diff two strings from a lookup.", - "description": "Lookup two strings and return a diff.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.lookupDiff", - "responses": { - "200": { - "description": "diffResult", - "content": { - "application/json": { - "schema": { - "title": "diffResult", - "type": "array", - "items": { - "type": "array" - }, - "examples": [ - [ - [-1, "version 16.12"], - [1, "Building configuration..."], - [0, "service timestamps debug datetime"], - [-1, "msec"], - [0, "localtime"] - ] - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "nextId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "collection": { - "title": "collection", - "type": "string", - "minLength": 1 - }, - "nextCollection": { - "title": "nextCollection", - "type": "string", - "minLength": 1 - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "type": { - "type": "boolean" - }, - "clean": { - "type": "string" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configurations/parser": { - "post": { - "summary": "Create a config parser.", - "description": "Create rules for a parser for breaking down configs in GC.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createConfigParser", - "responses": { - "200": { - "description": "data", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "minLength": 1 - }, - "lexRules": { - "title": "lexRules", - "items": { - "title": "lexRule", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - ["^{", "open_statement_block"], - ["^}", "close_statement_block"] - ] - } - }, - "template": { - "title": "template", - "type": "string", - "enum": ["cisco-ios", "f5-bigip"] - } - } - } - } - } - } - }, - "put": { - "summary": "Update a config parser.", - "description": "Update rules for a parser for breaking down configs in GC.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateConfigParser", - "responses": { - "200": { - "description": "result", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "updated": { - "type": "number" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "minLength": 1 - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "lexRules": { - "type": "array", - "items": { - "title": "ruleDefinitions", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - ["^{", "open_statemen_block"], - ["^}", "close_statemen_block"] - ] - } - }, - "template": { - "type": "string", - "examples": ["cisco-ios"] - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a config parser.", - "description": "Permanently delete a configuration parser.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteConfigParser", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "minLength": 1 - }, - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - }, - "get": { - "summary": "Get all config parsers.", - "description": "Gets a list of all known config parsers.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "start", - "in": "query", - "description": "start", - "required": false, - "schema": { - "type": "integer", - "minimum": 0, - "examples": [0] - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "examples": [20] - } - }, - { - "name": "regex", - "in": "query", - "description": "regex", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "filter", - "in": "query", - "description": "filter", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "integer", - "enum": [-1, 1] - }, - "date": { - "type": "integer", - "enum": [-1, 1] - } - } - } - } - ], - "operationId": "ConfigurationManager.getConfigParsers", - "responses": { - "200": { - "description": "List of config parsers found", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "array", - "items": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/configurations/parser/search": { - "post": { - "summary": "Get a config parser.", - "description": "Get a defined Config Parser from the database.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getConfigParser", - "responses": { - "200": { - "description": "data", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": { - "parser": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "filter": { - "title": "filter", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/configurations/parsers": { - "delete": { - "summary": "Delete one or more config parsers by Id", - "description": "This API call will delete config parsers based on given Ids", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteConfigParsers", - "responses": { - "200": { - "description": "Status with the number of config parsers deleted", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "deleted": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "parserIds": { - "title": "parserIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/import/parsers": { - "post": { - "summary": "Import parser documents", - "description": "Insert parser documents into the ucm_configs collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importParsers", - "responses": { - "200": { - "description": "Status of parser import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 device parsers imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "parsers": { - "title": "parsers", - "type": "array", - "items": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/configs": { - "get": { - "summary": "Get a list of all Golden Config trees.", - "description": "Get a list of all Golden Config trees.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getGoldenConfigTrees", - "responses": { - "200": { - "description": "List of all Golden Config trees", - "content": { - "application/json": { - "schema": { - "title": "goldenConfigTrees", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Adds a new Golden Config tree", - "description": "Adds a new Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createGoldenConfigTree", - "responses": { - "200": { - "description": "details of the initial version of the newly created tree", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": [ - "Cisco Edge - Day 0", - "Cisco Edge - Day 1", - "Cisco Core - Day 0", - "Cisco Core - Day 1" - ] - }, - "deviceType": { - "title": "deviceType", - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete one or more golden configuration trees by tree id", - "description": "This API call will delete golden configuration trees based on given tree ids", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteGoldenConfigTrees", - "responses": { - "200": { - "description": "Status with the number of golden configurations deleted", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "deleted": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeIds": { - "title": "treeIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/{treeId}": { - "get": { - "summary": "Get summary of a Golden Config tree.", - "description": "Get summary of the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getGoldenConfigTree", - "responses": { - "200": { - "description": "Requested Golden Config tree", - "content": { - "application/json": { - "schema": { - "title": "tree", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Adds a new Golden Config tree", - "description": "Adds a new Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "ID of the new Golden Config tree", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.createGoldenConfigTreeVersion", - "responses": { - "200": { - "description": "details of the initial version of the newly created tree", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "base": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - } - } - } - } - }, - "put": { - "summary": "Updates properties of a Golden Config tree", - "description": "Updates properties of the specified Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateGoldenConfigTree", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config tree updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["GC Tree Name"] - }, - "gbac": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - } - } - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a Golden Config tree.", - "description": "Deletes the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.deleteGoldenConfigTree", - "responses": { - "200": { - "description": "Result of the delete request", - "content": { - "application/json": { - "schema": { - "title": "deleteResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config tree deleted"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/configs/{treeId}/{version}": { - "get": { - "summary": "Get details of a Golden Config tree version.", - "description": "Get a detailed view of the specified Golden Config tree version.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - ], - "operationId": "ConfigurationManager.getGoldenConfigTreeVersion", - "responses": { - "200": { - "description": "Requested Golden Config tree version", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersion" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates properties of a Golden Config tree version", - "description": "Updates properties of the specified Golden Config tree version", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - ], - "operationId": "ConfigurationManager.updateGoldenConfigTreeVersion", - "responses": { - "200": { - "description": "status of creation and the new tree, if successful", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Configuration tree version updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["updated version name"] - }, - "variables": { - "title": "variables", - "type": "object", - "properties": {} - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a Golden Config tree.", - "description": "Deletes the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - ], - "operationId": "ConfigurationManager.deleteGoldenConfigTreeVersion", - "responses": { - "200": { - "description": "Result of the delete request", - "content": { - "application/json": { - "schema": { - "title": "deleteResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Configuration tree version deleted"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/search/configs": { - "post": { - "summary": "Get summary of a Golden Config tree.", - "description": "Get summary of the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchGoldenConfigTrees", - "responses": { - "200": { - "description": "List of all Golden Config trees", - "content": { - "application/json": { - "schema": { - "title": "goldenConfigTrees", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "properties": { - "start": { - "type": "number", - "example": "0" - }, - "limit": { - "type": "number", - "example": "10" - }, - "sort": { - "type": "number", - "example": 1 - }, - "deviceType": { - "type": "string", - "example": "cisco-ios" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/device/trees": { - "post": { - "summary": "Find trees which contain the specified device.", - "description": "Search through all GC Trees to find all locations where a device exists.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getTreesForDevice", - "responses": { - "200": { - "description": "List of trees that the device belongs to.", - "content": { - "application/json": { - "schema": { - "title": "trees", - "type": "array", - "items": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/tree": { - "post": { - "summary": "Fetches all the devices that exist on a tree.", - "description": "Search through a GC Tree to find all the devices that exist on it.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDevicesOnTree", - "responses": { - "200": { - "description": "Response containing the list of devices.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "nodes": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/variables/{treeId}/{version}": { - "delete": { - "summary": "Deletes one or more variables", - "description": "Verifies and deletes the requested deletion variables", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - } - ], - "operationId": "ConfigurationManager.deleteVariables", - "responses": { - "200": { - "description": "status of the variables to delete", - "content": { - "application/json": { - "schema": { - "title": "deleteResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Deletion successful."] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "variables": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigVariables" - } - } - } - } - } - } - } - }, - "/configuration_manager/configurations/rules": { - "put": { - "summary": "Updates the config rule set of a JSON Golden Config tree version", - "description": "Updates the config rule set of a JSON Golden Config tree version", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateJSONConfigRules", - "responses": { - "200": { - "description": "status of the rule set update.", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Rule Set successfully updated."] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "ruleSet": { - "title": "ruleSet", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/devices/groups": { - "delete": { - "summary": "Remove Device Groups from Node", - "description": "Remove device groups from a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.removeGroupsFromNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "deviceGroups": { - "title": "deviceGroups", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Add Device Groups to Node", - "description": "Add device groups to a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.addGroupsToNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "deviceGroups": { - "title": "deviceGroups", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/export/goldenconfigs": { - "post": { - "summary": "Export a Golden Config tree.", - "description": "Exports the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.exportGoldenConfigTree", - "responses": { - "200": { - "description": "Dereferenced golden config tree", - "content": { - "application/json": { - "schema": { - "title": "exportResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "data": { - "type": "array", - "title": "data", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - }, - "/configuration_manager/import/goldenconfigs": { - "post": { - "summary": "Import golden config tree documents", - "description": "Insert golden config documents into the golden config collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importGoldenConfigTree", - "responses": { - "200": { - "description": "Status of golden config import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 golden config trees imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "trees": { - "title": "trees", - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "array", - "description": "Documents of given tree per version", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary" - } - } - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/node/tasks": { - "delete": { - "summary": "Remove Tasks from Node", - "description": "Remove Tasks from a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.removeTasksFromNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "tasks": { - "title": "tasks", - "type": "array", - "items": { - "type": "string", - "title": "taskId", - "examples": ["5f9700486aa2ad95d85fc973"] - } - } - } - } - } - } - } - }, - "post": { - "summary": "Add Tasks to Node", - "description": "Add Tasks to a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.addTasksToNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "tasks": { - "title": "tasks", - "type": "array", - "items": { - "type": "string", - "title": "taskId", - "examples": ["5f9700486aa2ad95d85fc973"] - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/{treeId}/{version}/{nodePath(*)}/devices": { - "post": { - "summary": "Add Devices to Node", - "description": "Add devices to a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.addDevicesToNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "devices": { - "title": "devices", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Remove Devices from Node", - "description": "Remove devices from a node in a Golden Config tree", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.removeDevicesFromNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "devices": { - "title": "devices", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/{treeId}/{version}/{parentNodePath(*)}": { - "post": { - "summary": "Create a new node in a Golden Config tree.", - "description": "Create a new node in the specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "parentNodePath", - "in": "path", - "description": "parentNodePath", - "required": true, - "schema": { - "title": "parentNodePath", - "type": "string", - "examples": ["base/US East"] - } - } - ], - "operationId": "ConfigurationManager.createGoldenConfigNode", - "responses": { - "200": { - "description": "Newly created node", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNode" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["DC"] - } - } - } - } - } - } - } - }, - "/configuration_manager/configs/{treeId}/{version}/{nodePath(*)}": { - "put": { - "summary": "Update properties of a node in a Golden Config tree.", - "description": "Update properties of the specified Golden Config node.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.updateGoldenConfigNode", - "responses": { - "200": { - "description": "updateNodeResult", - "content": { - "application/json": { - "schema": { - "title": "updateNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Golden Config node updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["Southeast"] - }, - "attributes": { - "title": "attributes", - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "configId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a node in a Golden Config tree.", - "description": "Permanently delete the specified node in the Golden Config tree. Not reversible.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.deleteGoldenConfigNode", - "responses": { - "200": { - "description": "deleteNodeResult", - "content": { - "application/json": { - "schema": { - "title": "deleteNodeResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Configuration node deleted"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/config_specs/{id}": { - "get": { - "summary": "Get a Config Spec document.", - "description": "Get the details of the specified Config Spec.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getConfigSpec", - "responses": { - "200": { - "description": "configSpec", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpec" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update a Config Spec.", - "description": "Update content of the Config Spec.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateConfigSpec", - "responses": { - "200": { - "description": "configSpecUpdateResult", - "content": { - "application/json": { - "schema": { - "title": "configSpecUpdateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Config Spec updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "template": { - "type": "string", - "examples": ["ntp server {{ ipAddress }}"] - }, - "variables": { - "type": "string", - "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/config_template": { - "post": { - "summary": "Get a Config Spec template.", - "description": "Get the template of the specified Config Spec", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getConfigTemplate", - "responses": { - "200": { - "description": "template", - "content": { - "application/json": { - "schema": { - "title": "template", - "type": "object", - "properties": { - "currentTemplate": { - "type": "string" - }, - "inheritedTemplate": { - "type": "string" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/config_specs": { - "post": { - "summary": "Create a new Config Spec.", - "description": "Create a new Config Spec.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createConfigSpec", - "responses": { - "200": { - "description": "configSpec", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpec" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceType": { - "title": "deviceType", - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "data": { - "title": "data", - "type": "object", - "properties": { - "template": { - "type": "string", - "examples": ["ntp server {{ ipAddress }}"] - }, - "variables": { - "type": "string", - "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/node/config": { - "put": { - "summary": "Update node configuration.", - "description": "Updates the configuration for a specified node.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateNodeConfig", - "responses": { - "200": { - "description": "nodeUpdateResult", - "content": { - "application/json": { - "schema": { - "title": "nodeUpdateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Node Config updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "treeVersion": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "data": { - "title": "data", - "type": "object", - "properties": { - "template": { - "type": "string", - "examples": ["ntp server {{ ipAddress }}"] - }, - "variables": { - "type": "string", - "examples": ["{ \"ipAddress\": \"128.31.1.3\"}"] - } - } - }, - "updateVariables": { - "title": "updateVariables", - "type": "boolean" - } - } - } - } - } - } - } - }, - "/configuration_manager/translate/config_spec": { - "post": { - "summary": "Convert a config spec into a readable string.", - "description": "Converts a object like config into a human-readable config string.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.translateConfigSpec", - "responses": { - "200": { - "description": "configData", - "content": { - "application/json": { - "schema": { - "title": "configData", - "type": "object", - "properties": { - "config": { - "type": "string", - "examples": [ - "interface Loopback01\n description loopback01" - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeID": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/generate/config_spec": { - "post": { - "summary": "Builds a config spec from raw config.", - "description": "Takes raw native config and builds a configuration spec.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.buildSpecLines", - "responses": { - "200": { - "description": "specLines", - "content": { - "application/json": { - "schema": { - "title": "specLines", - "type": "array", - "properties": {}, - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecLine" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nativeConfig": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfigurationString" - }, - "deviceType": { - "title": "deviceType", - "type": "string", - "enum": [ - "cisco-ios", - "cisco-asa", - "cisco-ios-xr", - "cisco-nx", - "cisco-staros", - "alu-sr", - "a10-acos", - "juniper-junos", - "f5-bigip", - "arista-eos" - ] - }, - "options": { - "title": "options", - "properties": {}, - "type": "object" - } - } - } - } - } - } - } - }, - "/configuration_manager/json_specs/{id}": { - "get": { - "summary": "Get a JSON Spec document.", - "description": "Get the details of the specified JSON Spec.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getJSONSpec", - "responses": { - "200": { - "description": "JSONSpec", - "content": { - "application/json": { - "schema": { - "title": "JSONSpec", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Update a JSON Spec", - "description": "Update content of the JSON Spec.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.updateJSONSpec", - "responses": { - "200": { - "description": "jsonSpecUpdateResult", - "content": { - "application/json": { - "schema": { - "title": "jsonSpecUpdateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["JSON Spec updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/json_specs": { - "post": { - "summary": "Get a JSON Spec document with inheritance.", - "description": "Get the details of the specified JSON Spec with inheritance.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getJSONSpecWithInheritance", - "responses": { - "200": { - "description": "JSONSpec", - "content": { - "application/json": { - "schema": { - "title": "JSONSpec", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "options": { - "title": "options", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/json_specs/create": { - "post": { - "summary": "Create a new JSON Spec.", - "description": "Create a new JSON Spec.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createJSONSpec", - "responses": { - "200": { - "description": "jsonSpec", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigJSONSpec" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/config": { - "post": { - "summary": "Run Compliance Reports.", - "description": "Kick off one or more compliance checks for devices in a specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runConfigCompliance", - "responses": { - "200": { - "description": "runComplianceBatchResult", - "content": { - "application/json": { - "schema": { - "title": "runComplianceBatchResult", - "type": "object", - "properties": { - "status": { - "type": "integer", - "const": 202 - }, - "message": { - "type": "string", - "examples": ["compliance batch ${batchId} started"] - }, - "batchId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceName": { - "title": "deviceName", - "type": "string", - "examples": ["Cisco-Device.1"] - }, - "configuration": { - "title": "configuration", - "type": "string", - "examples": [ - "interface Loopback1\n ip address 10.0.0.1\nntp server 105.62.30.158" - ] - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports": { - "post": { - "summary": "Run Compliance Reports.", - "description": "Kick off one or more compliance checks for devices in a specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runCompliance", - "responses": { - "200": { - "description": "runComplianceBatchResult", - "content": { - "application/json": { - "schema": { - "title": "runComplianceBatchResult", - "type": "object", - "properties": { - "status": { - "type": "integer", - "const": 202 - }, - "message": { - "type": "string", - "examples": ["compliance batch ${batchId} started"] - }, - "batchId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "tasks": { - "type": "array", - "items": { - "type": "string" - }, - "examples": ["5f7b4c5ab2f4e0690520eed2"] - }, - "variables": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigVariables" - }, - "bidirectional": { - "type": "boolean" - } - }, - "required": ["treeId", "version"] - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/backups": { - "post": { - "summary": "Run Compliance Reports on Backups.", - "description": "Kick off one or more compliance checks for backups in a specified Golden Config tree.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runComplianceOnBackups", - "responses": { - "200": { - "description": "runComplianceBatchResult", - "content": { - "application/json": { - "schema": { - "title": "runComplianceBatchResult", - "type": "object", - "properties": { - "status": { - "type": "integer", - "const": 202 - }, - "message": { - "type": "string", - "examples": ["compliance batch ${batchId} started"] - }, - "batchId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeInfo": { - "title": "treeInfo", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - } - }, - "required": ["treeId", "version", "nodePath"] - }, - "backupIds": { - "title": "backupIds", - "type": "array", - "items": { - "type": "string", - "title": "backupId", - "examples": ["5f9700486aa2ad95d85fc973"] - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "bidirectional": { - "type": "boolean" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/tree/{treeId}": { - "get": { - "summary": "Summarize Compliance Reports for a Tree.", - "description": "Summarize Compliance Reports for a Tree.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getComplianceReportTreeSummary", - "responses": { - "200": { - "description": "complianceSummary", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceSummary" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/compliance_reports/node/{treeId}/{nodePath(*)}": { - "get": { - "summary": "Summarize Compliance Reports for a Node.", - "description": "Summarize Compliance Reports for a Node.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "treeId", - "in": "path", - "description": "treeId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - { - "name": "nodePath", - "in": "path", - "description": "nodePath", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - ], - "operationId": "ConfigurationManager.getComplianceReportNodeSummary", - "responses": { - "200": { - "description": "complianceSummary", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceSummary" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/compliance_reports/grade": { - "post": { - "summary": "Get graded compliance reports for a node.", - "description": "Get a set of graded and scored compliance reports for a node.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.gradeComplianceReports", - "responses": { - "200": { - "description": "graded_compliance_reports", - "content": { - "application/json": { - "schema": { - "title": "graded_compliance_reports", - "type": "array", - "items": { - "type": "object", - "properties": { - "grade": { - "type": "string", - "examples": ["pass", "review", "fail"] - }, - "total": { - "type": "integer", - "minimum": 0 - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "records": { - "type": "array", - "items": { - "type": "object", - "properties": { - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "reportId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "timestamp": { - "$ref": "#/components/schemas/configuration_manager_common_timestamp" - }, - "score": { - "type": "number" - }, - "grade": { - "type": "string", - "examples": ["pass", "review", "fail"] - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "options": { - "title": "options", - "allOf": [ - { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_reportGradingOptions" - }, - { - "type": "object", - "properties": { - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - } - ] - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/grade/single": { - "post": { - "summary": "Grade Report", - "description": "Get graded compliance report", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.gradeComplianceReport", - "responses": { - "200": { - "description": "graded_compliance_report", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportGraded" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reportId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_reportGradingOptions" - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/grade/history": { - "post": { - "summary": "Get historical graded compliance reports.", - "description": "Get historical graded compliance reports for a device on a node.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.gradeDeviceComplianceHistory", - "responses": { - "200": { - "description": "graded_compliance_history", - "content": { - "application/json": { - "schema": { - "title": "graded_compliance_history", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "options": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" - } - } - } - } - } - } - } - }, - "/configuration_manager/json_compliance_reports/grade/history": { - "post": { - "summary": "Get historical graded compliance reports.", - "description": "Get historical graded compliance reports for a task instance on a node.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.gradeTaskComplianceHistory", - "responses": { - "200": { - "description": "graded_compliance_history", - "content": { - "application/json": { - "schema": { - "title": "graded_compliance_history", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "taskId": { - "title": "taskId", - "type": "string", - "examples": ["5f80bd24f8479975bb46054d"] - }, - "options": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/query/history": { - "post": { - "summary": "Get historical graded compliance reports with pagination support.", - "description": "Get historical graded compliance reports for a device on a node with pagination support.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.queryGradedComplianceHistory", - "responses": { - "200": { - "description": "graded_compliance_history", - "content": { - "application/json": { - "schema": { - "title": "graded_compliance_history", - "properties": { - "total": { - "title": "total", - "type": "number" - }, - "history": { - "title": "history", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBriefGraded" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigTreeVersionName" - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - }, - "filter": { - "title": "filter", - "properties": { - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "taskId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - }, - "options": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions" - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/batch/{batchId}": { - "get": { - "summary": "Get compliance report metadata for a batch.", - "description": "Get compliance report metadata by batch ID.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "batchId", - "in": "path", - "description": "batchId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getComplianceReportsByBatch", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/json_compliance_reports/batch/{batchId}": { - "get": { - "summary": "Get compliance report metadata for a batch.", - "description": "Get compliance report metadata by batch ID.", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "batchId", - "in": "path", - "description": "batchId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getJSONComplianceReportsByBatch", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/compliance_reports/history": { - "post": { - "summary": "Compliance Reports totals for a Device.", - "description": "Compliance Reports totals for a Device.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getComplianceReportDeviceHistory", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "limit": { - "type": "integer", - "minimum": 1 - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/history/backups": { - "post": { - "summary": "Compliance Reports totals for a Backup.", - "description": "Compliance Reports totals for a Backup.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getComplianceReportBackupHistory", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "backups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "limit": { - "type": "integer", - "minimum": 1 - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/json_compliance_reports/history": { - "post": { - "summary": "Compliance Reports totals for a Task Instance.", - "description": "Compliance Reports totals for a Task Instance.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getComplianceReportTaskHistory", - "responses": { - "200": { - "description": "complianceHistory", - "content": { - "application/json": { - "schema": { - "title": "complianceHistory", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReportBrief" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "taskIds": { - "type": "array", - "items": { - "type": "string", - "title": "taskIds", - "examples": ["5f1063d78cf3b62347de4b87"] - } - }, - "limit": { - "type": "integer", - "minimum": 1 - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/details/{reportId}": { - "get": { - "summary": "Get Compliance Report", - "description": "Get the details of a particular compliance report", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "reportId", - "in": "path", - "description": "reportId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getComplianceReportDetail", - "responses": { - "200": { - "description": "complianceReportDetail", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/json_compliance_reports/details/{reportId}": { - "get": { - "summary": "Get JSON Compliance Report", - "description": "Get the details of a particular JSON compliance report", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "reportId", - "in": "path", - "description": "reportId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getJSONComplianceReportDetail", - "responses": { - "200": { - "description": "complianceReportDetail", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/compliance_reports/details": { - "post": { - "summary": "Get details of a particular set of compliance checks.", - "description": "Get details of a particular set of compliance checks.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getComplianceReportsDetail", - "responses": { - "200": { - "description": "complianceReportsDetail", - "content": { - "application/json": { - "schema": { - "title": "complianceReportsDetail", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_complianceReport" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "reportIds": { - "title": "reportIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_reports/topissues": { - "post": { - "summary": "Get the top issues from compliance reports", - "description": "Get the top most offending issues from all latest compliance reports", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getTopIssues", - "responses": { - "200": { - "description": "topIssuesResults", - "content": { - "application/json": { - "schema": { - "title": "topIssuesResults", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecLineId" - }, - "specWords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigSpecWord" - } - }, - "count": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/json_compliance_reports/topissues": { - "post": { - "summary": "Get the top issues from JSON compliance reports", - "description": "Get the top most offending issues from all latest JSON compliance reports", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getTopIssuesJson", - "responses": { - "200": { - "description": "topIssuesResults", - "content": { - "application/json": { - "schema": { - "title": "topIssuesResults", - "type": "array", - "items": { - "type": "object", - "properties": {} - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "treeId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "version": { - "type": "string", - "examples": ["v3"] - }, - "nodePath": { - "$ref": "#/components/schemas/configuration_manager_goldenConfigData_goldenConfigNodePath" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/patch_device/{deviceName}": { - "post": { - "summary": "Alters a device configuration", - "description": "Apply specified changes to a device configuration", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "deviceName", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.patchDeviceConfiguration", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "patchResult", - "type": "object", - "properties": { - "response": { - "type": "array", - "items": { - "type": "object", - "properties": { - "result": { - "type": "boolean" - }, - "parents": { - "type": "array", - "items": { - "type": "string" - } - }, - "new": { - "type": "string" - }, - "old": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "changes": { - "title": "changes", - "type": "array", - "items": { - "type": "object", - "properties": { - "parents": { - "type": "array", - "items": { - "type": "string", - "examples": ["parent line of config"] - } - }, - "old": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["old config line", null] - }, - "new": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["new config line", null] - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/patch_device/advanced/{deviceName}": { - "post": { - "summary": "Alters a device configuration", - "description": "Apply specified changes to a device configuration with additional options", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "deviceName", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.advancedPatchDeviceConfiguration", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "patchResult", - "type": "object", - "properties": { - "response": { - "type": "array", - "items": { - "type": "object", - "properties": { - "result": { - "type": "boolean" - }, - "parents": { - "type": "array", - "items": { - "type": "string" - } - }, - "new": { - "type": "string" - }, - "old": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "changes": { - "title": "changes", - "type": "array", - "items": { - "type": "object", - "properties": { - "parents": { - "type": "array", - "items": { - "type": "string", - "examples": ["parent line of config"] - } - }, - "old": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["old config line", null] - }, - "new": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["new config line", null] - } - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "backupDevice": { - "type": "boolean" - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/changes/convert": { - "post": { - "summary": "Converts patch data to native config.", - "description": "Converts the config patch data into a readable native config.", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.convertChangesToConfig", - "responses": { - "200": { - "description": "configData", - "content": { - "application/json": { - "schema": { - "title": "configData", - "type": "object", - "properties": { - "config": { - "type": "string", - "examples": [ - "interface Loopback01\n description loopback01" - ] - }, - "changes": { - "type": "array", - "items": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceType": { - "title": "deviceType", - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "changes": { - "title": "changes", - "type": "array", - "items": { - "type": "object", - "properties": { - "parents": { - "type": "array", - "items": { - "type": "string", - "examples": ["parent line of config"] - } - }, - "old": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["old config line", null] - }, - "new": { - "anyOf": [ - { - "const": null - }, - { - "type": "string" - } - ], - "examples": ["new config line", null] - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/actions/{device&:origin&:action}": { - "get": { - "summary": "Call Adapter Method", - "description": "Perform south bound specific logic via direct adapter call(s)", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "device", - "in": "path", - "description": "device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - { - "name": "origin", - "in": "path", - "description": "origin name", - "required": true, - "schema": { - "title": "origin", - "type": "string", - "examples": ["nso46", "ansible-us"] - } - }, - { - "name": "action", - "in": "path", - "description": "adapter action/function to be called", - "required": true, - "schema": { - "title": "action", - "type": "string", - "examples": ["checkSync"] - } - } - ], - "operationId": "ConfigurationManager.adapterProxy", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "adapterResponse", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/templates": { - "post": { - "summary": "Creates a device template", - "description": "Creates a new device template in pronghorn", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createDeviceTemplate", - "responses": { - "200": { - "description": "Result of creating a new device template", - "content": { - "application/json": { - "schema": { - "title": "data", - "properties": { - "result": { - "type": "string", - "example": "success" - }, - "data": { - "type": "object", - "example": { - "id": "610315295595a5fcb99f8ce2", - "name": "Cisco Login Banner", - "template": "banner login {{ bannerBody }}", - "variables": { - "bannerBody": "Welcome to this Cisco Device." - }, - "created": "2021-07-29T20:52:57.378Z", - "updated": "2021-07-29T20:52:57.378Z", - "createdBy": "5eaaf3796b16027c8aeb612a", - "updatedBy": "5eaaf3796b16027c8aeb612a", - "gbac": { - "write": [], - "read": [] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "template": { - "title": "template", - "type": "string", - "examples": [ - "interface Loopback1\n description {{ description }}" - ] - }, - "variables": { - "title": "variables", - "type": "object", - "properties": {} - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "deviceOSTypes": { - "type": "array" - } - } - } - } - } - } - } - } - }, - "put": { - "summary": "Updates a device template", - "description": "Updates a new device template in pronghorn", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateDeviceTemplate", - "responses": { - "200": { - "description": "Result of creating a new device template", - "content": { - "application/json": { - "schema": { - "title": "data", - "properties": { - "status": { - "type": "string", - "example": "success" - }, - "updated": { - "type": "number", - "example": 2 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "data": { - "title": "data", - "properties": { - "template": { - "type": "string", - "example": "ntp server {{ ipAddress }}" - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - }, - "name": { - "type": "string", - "example": "NTP Server Template" - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "deviceOSTypes": { - "type": "array" - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete one or more device template(s) by Id", - "description": "This API call will delete device templates based on given Ids", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteDeviceTemplates", - "responses": { - "200": { - "description": "Status with the number of device templates deleted", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "conflict"] - }, - "deleted": { - "type": "integer", - "minimum": 0 - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "templateIds": { - "title": "templateIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/templates/search": { - "post": { - "summary": "Gets a device template", - "description": "Gets a new device template in pronghorn", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.getDeviceTemplates", - "responses": { - "200": { - "description": "Result of creating a new device template", - "content": { - "application/json": { - "schema": { - "title": "data", - "properties": { - "total": { - "type": "number", - "example": 1 - }, - "list": { - "type": "object", - "example": [ - { - "id": "610315295595a5fcb99f8ce2", - "name": "Cisco Login Banner", - "template": "banner login {{ bannerBody }}", - "variables": { - "bannerBody": "Welcome to this Cisco Device." - }, - "created": "2021-07-29T20:52:57.378Z", - "updated": "2021-07-29T20:52:57.378Z", - "createdBy": "5eaaf3796b16027c8aeb612a", - "updatedBy": "5eaaf3796b16027c8aeb612a", - "gbac": { - "write": [], - "read": [] - } - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/import/templates": { - "post": { - "summary": "Import device config template documents", - "description": "Insert device config template documents into the device_templates collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importDeviceTemplates", - "responses": { - "200": { - "description": "Status of template import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 device template imported successfully" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "templates": { - "title": "templates", - "type": "array", - "items": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/{deviceName}/configuration": { - "post": { - "summary": "Apply a device config", - "description": "This API call will apply a configuration to a specified device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.applyDeviceConfig", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "config": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceConfiguration" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/templates/apply": { - "post": { - "summary": "Apply a device config template", - "description": "This API call will apply a configuration template to a specified device", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.applyDeviceTemplate", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deviceName": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - }, - "templateId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/devices/{deviceName}/operationaldata": { - "post": { - "summary": "Get operational data for a device", - "description": "Gets all the operational data for the specified device", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "deviceName", - "in": "path", - "description": "Device name", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - } - ], - "operationId": "ConfigurationManager.getOperationalData", - "responses": { - "200": { - "description": "Direct reponse from the origin's adapter", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "properties": { - "filter": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/import/plans": { - "post": { - "summary": "Import compliance plan documents", - "description": "Insert compliance plan documents into the ucm_compliance_plans collection", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.importCompliancePlan", - "responses": { - "200": { - "description": "Status of compliance plan import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 compliance plan(s) imported successfully." - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "plans": { - "title": "plans", - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "description": "The ID of the compliance plan." - }, - "name": { - "type": "string", - "description": "The name of the compliance plan to import" - }, - "description": { - "type": "string", - "description": "The description of the compliance plan to import" - }, - "nodes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "treeId": { - "type": "string", - "description": "The treeId of the GC that the node belongs to." - }, - "version": { - "type": "string", - "description": "The version of the GC tree that the node belongs to." - }, - "nodeId": { - "type": "string", - "description": "The configId of the node." - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - } - } - } - }, - "gbac": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plans": { - "post": { - "summary": "Creates a compliance plan", - "description": "Creates a compliance plan which can be used to execute compliance reports", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.createCompliancePlan", - "responses": { - "200": { - "description": "Details of the newly created compliance plan", - "content": { - "application/json": { - "schema": { - "title": "compliancePlan", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["Firewall Policies"] - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the compliance plan.", - "examples": ["A compliance plan for firewall configs."] - }, - "nodes": { - "type": "array", - "description": "Nodes to add into the compliance plan.", - "items": { - "type": "object", - "properties": { - "treeId": { - "type": "string", - "description": "The treeId of the GC that the node belongs to." - }, - "version": { - "type": "string", - "description": "The version of the GC tree that the node belongs to." - }, - "nodeId": { - "type": "string", - "description": "The configId of the node." - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "deviceGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "tasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - } - } - } - } - }, - "put": { - "summary": "Updates a compliance plan", - "description": "Updates a compliance plan that already exists", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateCompliancePlan", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Compliance Plan updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the compliance plan.", - "examples": ["A compliance plan for firewall configs."] - }, - "name": { - "type": "string", - "description": "New name for the Compliance Plan", - "examples": ["Firewall Policies"] - }, - "nodes": { - "type": "array", - "description": "Nodes to add into the compliance plan.", - "items": { - "type": "object", - "properties": { - "treeId": { - "type": "string", - "description": "The treeId of the GC that the node belongs to." - }, - "version": { - "type": "string", - "description": "The version of the GC tree that the node belongs to." - }, - "nodeId": { - "type": "string", - "description": "The configId of the node." - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "deviceGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "tasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - }, - "gbac": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["63696917c49ecc7b03b5f02b"] - } - } - } - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete compliance plans", - "description": "Delete the specified compliance plans", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.deleteCompliancePlans", - "responses": { - "200": { - "description": "Status of update operation", - "content": { - "application/json": { - "schema": { - "title": "deleteResult", - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "deleted": { - "type": "number" - } - }, - "required": ["status", "deleted"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planIds": { - "title": "planIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plans/{planId}": { - "get": { - "summary": "Fetches a compliance plan", - "description": "Fetches a compliance plan with the provided ID", - "tags": ["configuration_manager"], - "parameters": [ - { - "name": "planId", - "in": "path", - "description": "planId", - "required": true, - "schema": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - ], - "operationId": "ConfigurationManager.getCompliancePlan", - "responses": { - "200": { - "description": "Requested Golden Config tree version", - "content": { - "application/json": { - "schema": { - "title": "compliancePlan", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false - } - }, - "/configuration_manager/search/compliance_plans": { - "post": { - "summary": "Search all Compliance Plans", - "description": "Gets a list of all Compliance Plans that match the search criteria", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchCompliancePlans", - "responses": { - "200": { - "description": "List of Compliance Plans that match the search criteria", - "content": { - "application/json": { - "schema": { - "title": "compliancePlans", - "type": "object", - "properties": { - "totalCount": { - "type": "number" - }, - "groups": { - "type": "array", - "items": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "start": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "limit": { - "type": "integer", - "minimum": 1, - "examples": [20] - }, - "sort": { - "type": "number", - "example": 1 - } - }, - "required": ["start", "limit"] - } - } - } - } - } - } - } - }, - "/configuration_manager/search/compliance_plan_instances": { - "post": { - "summary": "Search all Compliance Plan instances", - "description": "Gets a list of all Compliance Plan Instances that match the search criteria", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.searchCompliancePlanInstances", - "responses": { - "200": { - "description": "List of Compliance Plan Instances that match the search criteria", - "content": { - "application/json": { - "schema": { - "title": "compliancePlanInstances", - "type": "object", - "properties": { - "totalCount": { - "type": "number" - }, - "groups": { - "type": "array", - "items": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "searchParams": { - "title": "searchParams", - "type": "object", - "properties": { - "instanceId": { - "type": "string", - "description": "ID of the instance to fetch" - }, - "planId": { - "type": "string", - "description": "Fetches all instances with this planId" - }, - "planName": { - "type": "string", - "description": "Fetches all instances with this planName" - }, - "description": { - "type": "string", - "description": "Filter by description of the plan instance.", - "example": ["A description for my compliance plan."] - }, - "status": { - "type": "string", - "description": "Filter by status of the Job pertainig to the plan instance.", - "enum": [ - "running", - "complete", - "paused", - "error", - "canceled" - ] - }, - "dateRange": { - "type": "array", - "description": "An array containing the start and end date. Index 0 = start date, index 1 = end date.", - "items": {} - }, - "start": { - "type": "integer", - "minimum": 0, - "examples": [0] - }, - "limit": { - "type": "integer", - "minimum": 1, - "examples": [20] - }, - "sort": { - "type": "object", - "properties": { - "started": { - "enum": [-1, 1] - }, - "jobStatus": { - "enum": [-1, 1] - }, - "name": { - "enum": [-1, 1] - } - } - } - }, - "oneOf": [ - { - "required": ["instanceId"] - }, - { - "required": ["planId"] - }, - { - "required": ["planName"] - } - ] - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plans/nodes": { - "post": { - "summary": "Adds node(s) to a compliance plan", - "description": "Adds new node(s) to an already existing compliance plan", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.addNodesToCompliancePlan", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": [ - "Successfully added node(s) to compliance plan" - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "nodes": { - "title": "nodes", - "type": "array", - "items": { - "type": "object", - "properties": { - "treeId": { - "type": "string", - "description": "The treeId of the GC that the node belongs to." - }, - "version": { - "type": "string", - "description": "The version of the GC tree that the node belongs to." - }, - "nodeId": { - "type": "string", - "description": "The configId of the node." - }, - "variables": { - "type": "object", - "example": "{ \"ipAddress\": \"1.2.3.4\" }" - }, - "devices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_deviceData_deviceName" - } - }, - "deviceGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "tasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - } - } - } - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - }, - "delete": { - "summary": "Removes node(s) from a compliance plan", - "description": "Removes new node(s) from an already existing compliance plan", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.removeNodesFromCompliancePlan", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": [ - "Successfully added node(s) to compliance plan" - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "nodeIds": { - "title": "nodeIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - } - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plans/run": { - "post": { - "summary": "Runs a compliance plan", - "description": "This API call will create WF job that will execute the compliance plan", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.runCompliancePlan", - "responses": { - "200": { - "description": "The details of the plan instance that was created.", - "content": { - "application/json": { - "schema": { - "title": "response", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "type": "object", - "properties": {} - } - } - } - } - } - } - } - }, - "/configuration_manager/compliance_plan_instances": { - "put": { - "summary": "Update properties of a compliance plan instance", - "description": "Update properties of the specified compliance plan instance", - "tags": ["configuration_manager"], - "parameters": [], - "operationId": "ConfigurationManager.updateCompliancePlanInstance", - "responses": { - "200": { - "description": "updateResult", - "content": { - "application/json": { - "schema": { - "title": "updateResult", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "examples": ["Compliance Run Report updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "CookieAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ], - "BasicAuth": [ - "ConfigurationManager.admin", - "ConfigurationManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "planId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "instanceId": { - "$ref": "#/components/schemas/configuration_manager_common_mongoObjectId" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "type": "string", - "examples": ["Compliance plan instance description"] - } - } - } - } - } - } - } - } - } - }, - "/automation-studio/templates": { - "get": { - "summary": "Gets a page of template documents.", - "description": "Gets a page of template documents.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - } - }, - { - "name": "exclude-project-members", - "in": "query", - "description": "Flag which removes workflows from the results which are members of a project", - "required": false, - "schema": { - "type": "boolean", - "description": "Flag which removes workflows from the results which are members of a project" - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "in", - "in": "query", - "description": "Search for fields exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "not-in", - "in": "query", - "description": "Search for fields not exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "equals", - "in": "query", - "description": "Returns results where the specified fields exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string" - } - }, - { - "name": "contains", - "in": "query", - "description": "Returns results where the specified fields contain the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields contain the given match string(s).", - "type": "string" - } - }, - { - "name": "starts-with", - "in": "query", - "description": "Returns results where the specified fields start with the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string" - } - }, - { - "name": "ends-with", - "in": "query", - "description": "Returns results where the specified fields end in the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.getTemplates", - "responses": { - "200": { - "description": "Results for the given search parameters.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_template" - } - }, - "total": { - "type": "integer", - "description": "Total number of documents matching the given query parameters." - }, - "start": { - "type": "integer", - "description": "Search index of first document in the items array." - }, - "end": { - "type": "integer", - "description": "Search index of the last document in the items array." - }, - "count": { - "type": "integer", - "description": "Length of the items array." - }, - "next": { - "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "previous": { - "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Creates a new template document.", - "description": "Creates a new template document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.createTemplate", - "responses": { - "200": { - "description": "Created template and associated edit URI.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "description": "Created template and associated edit URI.", - "properties": { - "created": { - "$ref": "#/components/schemas/automation-studio_template" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the newly created template." - } - }, - "required": ["created", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "$ref": "#/components/schemas/automation-studio_template" - } - } - } - } - } - } - } - }, - "/automation-studio/templates/{id}": { - "get": { - "summary": "Gets a single template document.", - "description": "Gets a single template document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ObjectId specifying a template entity.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "ObjectId specifying a template entity." - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - } - ], - "operationId": "AutomationStudio.getTemplate", - "responses": { - "200": { - "description": "Transformed data.", - "content": { - "application/json": { - "schema": { - "title": "output", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Deletes a template document.", - "description": "Deletes a template document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Template id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Template id." - } - } - ], - "operationId": "AutomationStudio.deleteTemplate", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Message denoting the status of the delete operation." - } - }, - "required": ["message"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Replaces a template document.", - "description": "Replaces a template document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Template id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Template id." - } - } - ], - "operationId": "AutomationStudio.updateTemplate", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "updated": { - "$ref": "#/components/schemas/automation-studio_template" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the updated template." - } - }, - "required": ["updated", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "update": { - "$ref": "#/components/schemas/automation-studio_templateUpdate" - } - } - } - } - } - } - } - }, - "/automation-studio/templates/import": { - "post": { - "summary": "Imports a new template document.", - "description": "Imports a new template document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.importTemplates", - "responses": { - "200": { - "description": "Results from each individual import operation.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "imported": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Status flag denoting the success (true) or failure (false) of the template's import operation." - }, - "message": { - "type": "string", - "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." - }, - "original": { - "$ref": "#/components/schemas/automation-studio_templateImport" - }, - "created": { - "description": "The imported template as it exists after being imported.", - "oneOf": [ - { - "$ref": "#/components/schemas/automation-studio_template" - }, - { - "type": "null" - } - ] - }, - "edit": { - "description": "URI to the edit page for the imported template.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "status", - "message", - "original", - "created", - "edit" - ] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "templates": { - "title": "templates", - "description": "Array of template documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a template's name is already used in the templates collection, it will be renamed with a numeric suffix.", - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_templateImport" - } - } - } - } - } - } - } - } - }, - "/automation-studio/templates/{id}/export": { - "get": { - "summary": "Exports a template document.", - "description": "Exports a template document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Template id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Template id." - } - } - ], - "operationId": "AutomationStudio.exportTemplate", - "responses": { - "200": { - "description": "Exported representation of the template.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_templateImport" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/json-forms/method-options": { - "get": { - "summary": "Get all available rest calls in IAP.", - "description": "Get all available rest calls in IAP.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.getMethodOptions", - "responses": { - "200": { - "description": "List of all rest calls available in the system.", - "content": { - "application/json": { - "schema": { - "title": "calls", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "getTemplate", - "createTemplate", - "importTemplates", - "exportTemplate" - ] - }, - "sourceType": { - "type": "string", - "examples": [ - "AutomationStudio", - "ConfigurationManager", - "MOP" - ] - }, - "path": { - "type": "string", - "examples": [ - "/templates/:id", - "/createTemplate", - "/listAnalyticTemplates" - ] - }, - "verb": { - "type": "string", - "enum": ["GET", "POST"] - }, - "origin": { - "type": "string", - "examples": [ - "/automation-studio", - "/mop", - "/validate-form/:id" - ] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AutomationStudio.admin"], - "CookieAuth": ["AutomationStudio.admin"], - "BasicAuth": ["AutomationStudio.admin"] - } - ], - "deprecated": false - } - }, - "/automation-studio/apps/list": { - "get": { - "summary": "Get a list of all the apps and adapters", - "description": "Get all apps and adapters.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.getAppsAndAdapters", - "responses": { - "200": { - "description": "List of all apps and adapters.", - "content": { - "application/json": { - "schema": { - "title": "apps_list", - "type": "array", - "items": { - "type": "object", - "examples": [ - { - "id": "@itential/app-admin_essentials", - "type": "UI", - "name": "AdminEssentials" - }, - { - "id": "@itential/app-automation_studio", - "type": "Application", - "name": "AutomationStudio" - }, - { - "id": "@itential/app-configuration_manager", - "type": "Application", - "name": "ConfigurationManager" - }, - { - "id": "@itential/app-ag_manager", - "type": "Application", - "name": "AGManager" - }, - { - "id": "@itential/app-form_builder", - "type": "Application", - "name": "FormBuilder" - } - ] - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/workflows": { - "get": { - "summary": "Gets a page of workflow documents.", - "description": "Gets a page of workflow documents.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - } - }, - { - "name": "exclude-project-members", - "in": "query", - "description": "Flag which removes workflows from the results which are members of a project", - "required": false, - "schema": { - "type": "boolean", - "description": "Flag which removes workflows from the results which are members of a project" - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "expand", - "in": "query", - "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", - "required": false, - "schema": { - "type": "string", - "title": "List of fields to get expanded data", - "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", - "examples": ["created_by,user,owner"] - } - }, - { - "name": "in", - "in": "query", - "description": "Search for fields exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string", - "examples": [ - "in[name]=my-workflow,or-this-workflow&in[type]=automation" - ] - } - }, - { - "name": "not-in", - "in": "query", - "description": "Search for fields not exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string", - "examples": ["not-in[name]=my-workflow,not-this-workflow"] - } - }, - { - "name": "equals", - "in": "query", - "description": "Returns results where the specified fields exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string", - "examples": ["equals[name]=my-workflow"] - } - }, - { - "name": "contains", - "in": "query", - "description": "Returns results where the specified fields contain the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields contain the given match string(s).", - "type": "string", - "examples": ["contains[name]=workflow"] - } - }, - { - "name": "starts-with", - "in": "query", - "description": "Returns results where the specified fields start with the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string", - "examples": ["starts-with[name]=my-"] - } - }, - { - "name": "ends-with", - "in": "query", - "description": "Returns results where the specified fields end in the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string", - "examples": ["ends-with[name]=-workflow"] - } - }, - { - "name": "task-equals", - "in": "query", - "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", - "type": "string", - "examples": ["task-equals[app]=WorkFlowEngine"] - } - } - ], - "operationId": "AutomationStudio.getWorkflows", - "responses": { - "200": { - "description": "Results for the given search parameters.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_workflowDocument" - } - }, - "total": { - "type": "integer", - "description": "Total number of documents matching the given query parameters." - }, - "start": { - "type": "integer", - "description": "Search index of first document in the items array." - }, - "end": { - "type": "integer", - "description": "Search index of the last document in the items array." - }, - "count": { - "type": "integer", - "description": "Length of the items array." - }, - "limit": { - "type": "integer", - "description": "Number of results to return. Used for pagination." - }, - "next": { - "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "previous": { - "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/workflows/detailed/{name}": { - "get": { - "summary": "Get Details of a Workflow", - "description": "Get the details of a Workflow by Workflow name.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow to get Workflow details.", - "required": true, - "schema": { - "type": "string", - "title": "name" - } - } - ], - "operationId": "AutomationStudio.getWorkflowDetailedByName", - "responses": { - "200": { - "description": "Workflow details matching the Workflow name.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_workflowDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/automations": { - "post": { - "summary": "Creates a new workflow document.", - "description": "Creates a new workflow document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.createAutomation", - "responses": { - "200": { - "description": "Created workflow and associated edit URI.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "description": "Created workflow and associated edit URI.", - "properties": { - "created": { - "$ref": "#/components/schemas/automation-studio_automation" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the newly created workflow." - } - }, - "required": ["created", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "automation": { - "$ref": "#/components/schemas/automation-studio_automation" - } - } - } - } - } - } - } - }, - "/automation-studio/automations/{id}": { - "put": { - "summary": "Replaces a workflow document.", - "description": "Replaces a workflow document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Workflow id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Workflow id." - } - } - ], - "operationId": "AutomationStudio.updateAutomation", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "updated": { - "$ref": "#/components/schemas/automation-studio_automation" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the updated workflow." - } - }, - "required": ["updated", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "update": { - "$ref": "#/components/schemas/automation-studio_automationUpdate" - } - } - } - } - } - } - } - }, - "/automation-studio/automations/import": { - "post": { - "summary": "Imports a new workflow document.", - "description": "Imports a new workflow document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.importAutomations", - "responses": { - "200": { - "description": "Results from each individual import operation.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "imported": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Status flag denoting the success (true) or failure (false) of the workflow's import operation." - }, - "message": { - "type": "string", - "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." - }, - "original": { - "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" - }, - "created": { - "description": "The imported workflow as it exists after being imported.", - "oneOf": [ - { - "$ref": "#/components/schemas/automation-studio_workflowDocument" - }, - { - "type": "null" - } - ] - }, - "edit": { - "description": "URI to the edit page for the imported workflow.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "status", - "message", - "original", - "created", - "edit" - ] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "automations": { - "title": "automations", - "description": "Array of workflow documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'.", - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" - } - } - } - } - } - } - } - } - }, - "/automation-studio/component-groups": { - "get": { - "summary": "Gets a page of component group documents.", - "description": "Gets a page of component group documents.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "in", - "in": "query", - "description": "Search for fields exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "not-in", - "in": "query", - "description": "Search for fields not exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "equals", - "in": "query", - "description": "Returns results where the specified fields exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string" - } - }, - { - "name": "contains", - "in": "query", - "description": "Returns results where the specified fields contain the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields contain the given match string(s).", - "type": "string" - } - }, - { - "name": "starts-with", - "in": "query", - "description": "Returns results where the specified fields start with the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string" - } - }, - { - "name": "ends-with", - "in": "query", - "description": "Returns results where the specified fields end in the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.getComponentGroups", - "responses": { - "200": { - "description": "Results for the given search parameters.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_componentGroup" - } - }, - "total": { - "type": "integer", - "description": "Total number of documents matching the given query parameters.", - "examples": [100] - }, - "start": { - "type": "integer", - "description": "Search index of first document in the items array.", - "examples": [0] - }, - "end": { - "type": "integer", - "description": "Search index of the last document in the items array.", - "examples": [100] - }, - "count": { - "type": "integer", - "description": "Length of the items array.", - "examples": [100] - }, - "next": { - "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "previous": { - "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Creates a new component group document.", - "description": "Creates a new component group document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.createComponentGroup", - "responses": { - "200": { - "description": "Created component group and associated edit URI.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "description": "Created component group and associated edit URI.", - "properties": { - "created": { - "$ref": "#/components/schemas/automation-studio_componentGroup" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the newly created component group." - } - }, - "required": ["created", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "componentGroup": { - "$ref": "#/components/schemas/automation-studio_componentGroup" - } - } - } - } - } - } - } - }, - "/automation-studio/component-groups/{id}": { - "get": { - "summary": "Gets a single component group document.", - "description": "Gets a single component group document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ObjectId specifying a component group entity.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "ObjectId specifying a component group entity." - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - } - ], - "operationId": "AutomationStudio.getComponentGroup", - "responses": { - "200": { - "description": "Transformed data.", - "content": { - "application/json": { - "schema": { - "title": "output", - "type": "object", - "examples": [ - { - "_id": "67d863a07620432ed58f7964", - "name": "Automation Studio", - "description": "", - "gbacRead": [], - "gbacWrite": [], - "members": [ - { - "path": ["addComponentsToProject"], - "ref": "2c27f941-aa37-42b2-9ecf-d0398676745d", - "sourceCollection": "workflows", - "type": "component", - "name": "addComponentsToProject" - }, - { - "path": ["createProject"], - "ref": "887d1e2d-3641-41f4-9f93-40bc0f134b5b", - "sourceCollection": "workflows", - "type": "component", - "name": "createProject" - } - ] - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.readonly", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Deletes a component group document.", - "description": "Deletes a component group document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Component group id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Component group id." - } - } - ], - "operationId": "AutomationStudio.deleteComponentGroup", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Message denoting the status of the delete operation.", - "examples": [ - "Deleted componentGroup 67d32e60a402649caa29a006" - ] - } - }, - "required": ["message"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Replaces a component group document.", - "description": "Replaces a component group document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Component group id.", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Component group id." - } - } - ], - "operationId": "AutomationStudio.updateComponentGroup", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "updated": { - "$ref": "#/components/schemas/automation-studio_componentGroup" - }, - "edit": { - "type": "string", - "description": "URI to the edit page for the updated component group." - } - }, - "required": ["updated", "edit"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "update": { - "$ref": "#/components/schemas/automation-studio_componentGroupUpdate" - } - } - } - } - } - } - } - }, - "/automation-studio/component-groups/import": { - "post": { - "summary": "Imports a new component group document.", - "description": "Imports a new component group document.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.importComponentGroups", - "responses": { - "200": { - "description": "Results from each individual import operation.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "imported": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "description": "Status flag denoting the success (true) or failure (false) of the component group's import operation." - }, - "message": { - "type": "string", - "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." - }, - "original": { - "$ref": "#/components/schemas/automation-studio_componentGroupImport" - }, - "created": { - "description": "The imported component group as it exists after being imported.", - "oneOf": [ - { - "$ref": "#/components/schemas/automation-studio_componentGroup" - }, - { - "type": "null" - } - ] - }, - "edit": { - "description": "URI to the edit page for the imported component group.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "status", - "message", - "original", - "created", - "edit" - ] - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "componentGroups": { - "title": "componentGroups", - "description": "Array of component group documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a component group's name is already used in the component groups collection, it will be renamed with a numeric suffix.", - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_componentGroupImport" - } - } - } - } - } - } - } - } - }, - "/automation-studio/workflows/validate": { - "post": { - "summary": "Validate a workflow", - "description": "Validate a workflow, and return the resulting errors and warnings arrays.", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.validateWorkflow", - "responses": { - "200": { - "description": "Errors and warnings output from the validation process", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "validationResult", - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object" - } - }, - "warnings": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread", - "AutomationStudio.apiwrite" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread", - "AutomationStudio.apiwrite" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.engineering", - "AutomationStudio.support", - "AutomationStudio.apiread", - "AutomationStudio.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/automation-studio_workflowDocumentAll" - } - } - } - } - } - } - } - }, - "/automation-studio/references-to": { - "get": { - "summary": "Gets references to a particular document.", - "description": "Gets references to a particular document.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "target-type", - "in": "query", - "description": "Type of document to search for references to.", - "required": false, - "schema": { - "type": "string", - "description": "Type of document to search for references to." - } - }, - { - "name": "target-identifiers", - "in": "query", - "description": "IDs of the components to search for references to.", - "required": false, - "schema": { - "type": "string", - "description": "IDs of the components to search for references to." - } - }, - { - "name": "referrer-type", - "in": "query", - "description": "Type of documents to search for references in.", - "required": false, - "schema": { - "type": "string", - "description": "Type of documents to search for references in." - } - } - ], - "operationId": "AutomationStudio.getReferencesTo", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "referencesByTarget": { - "type": "array", - "items": { - "type": "object", - "properties": { - "target": { - "type": "object", - "properties": { - "identifer": { - "type": "string", - "examples": [ - "940a1b4f-399a-44df-a42e-d37da51c7637", - "5eb596edf955d0e5288f84ef" - ] - }, - "type": { - "type": "string", - "enum": [ - "workflow", - "json-form", - "transformation", - "template", - "command-template", - "analytic-template", - "form" - ] - } - } - }, - "totalReferencingInstances": { - "type": "number" - }, - "totalReferences": { - "type": "number" - }, - "references": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "workflow", - "json-form", - "transformation", - "template", - "command-template", - "analytic-template", - "form" - ] - }, - "_id": { - "type": "string", - "examples": [ - "940a1b4f-399a-44df-a42e-d37da51c7637", - "5eb596edf955d0e5288f84ef" - ] - }, - "name": { - "type": "string" - }, - "referencePaths": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer" - ] - } - ], - "deprecated": true - } - }, - "/automation-studio/locations/{location}/packages/{pckg}/tasks/{method}": { - "get": { - "summary": "Get Task Details", - "description": "Get the detailed information model for a task", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "location", - "in": "path", - "description": "Location: Application, Broker, Adapter", - "required": true, - "schema": { - "type": "string", - "title": "location" - } - }, - { - "name": "pckg", - "in": "path", - "description": "Package name", - "required": true, - "schema": { - "type": "string", - "title": "pckg", - "examples": ["WorkFlowEngine"] - } - }, - { - "name": "method", - "in": "path", - "description": "Method name", - "required": true, - "schema": { - "type": "string", - "title": "method", - "examples": ["query", "merge"] - } - } - ], - "operationId": "AutomationStudio.getTaskDetails", - "responses": { - "200": { - "description": "Detailed information on a task", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_taskDetails" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] - } - ], - "deprecated": false - } - }, - "/automation-studio/multipleTaskDetails": { - "post": { - "summary": "Get Task Details", - "description": "Get the detailed information model for a task", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.getMultipleTaskDetails", - "responses": { - "200": { - "description": "Detailed information on a task", - "content": { - "application/json": { - "schema": { - "type": "array", - "title": "taskDetails", - "items": { - "$ref": "#/components/schemas/automation-studio_taskDetails" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "inputsArray": { - "type": "array", - "title": "inputsArray", - "items": { - "type": "object", - "properties": { - "location": { - "title": "location", - "type": "string", - "description": "Location: Application, Broker, Adapter", - "examples": ["Application", "Adapter", "Broker"] - }, - "pckg": { - "title": "pckg", - "type": "string", - "description": "Package name", - "examples": ["WorkFlowEngine"] - }, - "method": { - "title": "method", - "type": "string", - "description": "Method name", - "examples": ["query", "merge"] - } - } - } - } - } - } - } - } - } - } - }, - "/automation-studio/projects": { - "get": { - "summary": "Search projects", - "description": "Search projects", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.getProjects", - "responses": { - "200": { - "description": "Projects", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully retrieved projects"] - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - }, - "metadata": { - "type": "object", - "properties": { - "skip": { - "type": "number" - }, - "limit": { - "type": "number" - }, - "total": { - "type": "number" - }, - "previousPageSkip": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - } - ] - }, - "nextPageSkip": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "number" - } - ] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] - } - ], - "deprecated": false - }, - "post": { - "summary": "Creates a new project", - "description": "Creates a new project", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.createProject", - "responses": { - "200": { - "description": "Create result", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully created project"] - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "createData", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_projects-create-data" - } - } - } - } - } - }, - "/automation-studio/projects/{projectId}": { - "get": { - "summary": "Gets a single Project", - "description": "Gets a single Project", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.getProject", - "responses": { - "200": { - "description": "API response body", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully retrieved project"] - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Updates an existing project", - "description": "Updates an existing project", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier, either an ObjectId or an IID", - "required": true, - "schema": { - "$ref": "#/components/schemas/automation-studio_projects-http-id" - } - } - ], - "operationId": "AutomationStudio.updateProject", - "responses": { - "200": { - "description": "Update result", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "updateData", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_projects-update-data" - } - } - } - } - } - }, - "/automation-studio/projects/{id}/export": { - "get": { - "summary": "Exports a project document as a JSON document, inlining all related documents into its components array", - "description": "Exports a project document as a JSON document, inlining all related documents into its components array", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "title": "id", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.exportProject", - "responses": { - "200": { - "description": "Exported project", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully exported project"] - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-export-v1" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/projects/import": { - "post": { - "summary": "Imports a project document from a JSON document", - "description": "Imports a project document from a JSON document", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.importProject", - "responses": { - "200": { - "description": "Import result", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "properties": { - "project": { - "$ref": "#/components/schemas/automation-studio_projects-export-v1" - }, - "conflictMode": { - "type": "string", - "enum": ["overwrite", "insert-new"] - }, - "skipReferenceValidation": { - "type": "boolean", - "description": "If true, validations will not be run against references.", - "default": false - }, - "assignNewReferences": { - "type": "boolean", - "description": "This being true would indicate that the imported project is part of a clone action.", - "default": false - } - } - } - } - } - } - } - }, - "/automation-studio/discoverReferences": { - "post": { - "summary": "Discover referenced resources", - "description": "Finds all resource references from a set of specified resource identifiers", - "tags": ["automation-studio"], - "parameters": [], - "operationId": "AutomationStudio.discoverReferences", - "responses": { - "200": { - "description": "References", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_resource-ref-http" - } - } - } - ] - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer", - "AutomationStudio.engineering" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer", - "AutomationStudio.engineering" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread", - "AutomationStudio.designer", - "AutomationStudio.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "properties": { - "resourceIdentifiers": { - "type": "array", - "description": "Array of resource identifiers to find references for.", - "items": { - "type": "object", - "properties": { - "resourceType": { - "type": "string", - "description": "The type of the resource." - }, - "resourcePointer": { - "type": "string", - "description": "The pointer to the identifier value in the resource object." - }, - "resourceId": { - "type": "string", - "description": "The value of the identifier in the resource object." - }, - "recursionDepth": { - "type": "integer", - "description": "Specifies the number of hierarchical levels to traverse when discovering references for this component. If omitted, the search on this component will be fully recursive." - } - } - } - }, - "recursive": { - "type": "boolean", - "description": "If true, recursively looks up resources on all referenced resources.", - "default": false - }, - "includeResources": { - "type": "boolean", - "description": "If true, include the full resource document in each resource reference object.", - "default": false - }, - "ignore": { - "type": "object", - "description": "An object of resource types to directions that will not be included in discovery. Cannot be used with include.", - "additionalProperties": { - "enum": ["up", "down", "all"] - } - }, - "include": { - "type": "object", - "description": "An object of resource types and directions to be included in discovery. Cannot be used with ignore.", - "additionalProperties": { - "enum": ["up", "down", "all"] - } - }, - "removeCycles": { - "type": "boolean", - "description": "If true, removes all cyclic relationships from the list of resource references.", - "default": false - } - } - } - } - } - } - } - }, - "/automation-studio/projects/{id}": { - "delete": { - "summary": "Delete a project and any components it contains", - "description": "Delete a project and any components it contains", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Project ID", - "required": true, - "schema": { - "title": "id", - "type": "string", - "description": "Project ID" - } - } - ], - "operationId": "AutomationStudio.deleteProject", - "responses": { - "200": { - "description": "Response object.", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Message denoting the status of the delete operation." - } - }, - "required": ["message"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false - } - }, - "/automation-studio/projects/{projectId}/components/{componentId}": { - "delete": { - "summary": "Remove a component from a project", - "description": "Remove a component from a project", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string", - "description": "Project identifier" - } - }, - { - "name": "componentId", - "in": "path", - "description": "Component identifier", - "required": true, - "schema": { - "title": "componentId", - "type": "number", - "description": "Component identifier" - } - } - ], - "operationId": "AutomationStudio.removeComponentFromProject", - "responses": { - "200": { - "description": "Response object", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Message denoting the status of the delete operation" - }, - "data": { - "$ref": "#/components/schemas/automation-studio_projects-http" - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "description": "Options designating removal mode", - "properties": { - "mode": { - "type": "string", - "enum": ["delete", "move"] - } - } - } - } - } - } - } - } - } - }, - "/automation-studio/projects/{projectId}/components/add": { - "post": { - "summary": "Add one or more components to Project", - "description": "Add one or more components to Project", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.addComponentsToProject", - "responses": { - "200": { - "description": "Updated project", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - }, - "metadata": { - "type": "object", - "properties": { - "newComponents": { - "type": "array", - "description": "Components added" - }, - "failedComponents": { - "type": "array", - "description": "Components failed to add" - }, - "idMap": { - "type": "array", - "description": "Id map for original and cloned component", - "examples": [ - [ - { - "original": "1a643151-459b-4a4a-be91-623536b65df3", - "clone": "8696f332-030b-4c2a-8b1b-95844cbb6aea" - } - ] - ] - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "required": ["components"], - "properties": { - "components": { - "$ref": "#/components/schemas/automation-studio_projects-common_components" - }, - "mode": { - "type": "string", - "enum": ["move", "copy"] - } - } - } - } - } - } - } - }, - "/automation-studio/projects/{projectId}/thumbnail": { - "put": { - "summary": "Set a project's thumbnail image", - "description": "Set a project's thumbnail image", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.uploadProjectThumbnail", - "responses": { - "200": { - "description": "Updated project", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/automation-studio_projects-http" - } - }, - "metadata": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ], - "BasicAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiwrite", - "AutomationStudio.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/automation-studio_project-thumbnails-update-data" - } - } - } - } - }, - "get": { - "summary": "Gets a Project's thumbnail", - "description": "Gets a Project's thumbnail. Returns data as a base64 encoded string of binary data.", - "tags": ["automation-studio"], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project identifier", - "required": true, - "schema": { - "title": "projectId", - "type": "string" - } - } - ], - "operationId": "AutomationStudio.getProjectThumbnail", - "responses": { - "200": { - "description": "API response body", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Successfully retrieved project thumbnail"] - }, - "data": { - "type": "object", - "properties": { - "image": { - "description": "Base64 encoded binary contents of the image file", - "type": "string", - "examples": [""] - }, - "backgroundColor": { - "description": "Hex value of thumbnail background color", - "type": "string", - "examples": ["#FFFFFF"] - }, - "metadata": { - "type": "object" - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"], - "CookieAuth": [ - "AutomationStudio.admin", - "AutomationStudio.apiread" - ], - "BasicAuth": ["AutomationStudio.admin", "AutomationStudio.apiread"] - } - ], - "deprecated": false - } - }, - "/tags/get": { - "post": { - "summary": "Get tag details given an id", - "description": "Get details and results for a single tag given that tags id.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.get", - "responses": { - "200": { - "description": "Tag details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "title": "id", - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - } - } - } - } - } - } - } - }, - "/tags/find": { - "post": { - "summary": "Find tags by name", - "description": "Find a list of tags given a name.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.find", - "responses": { - "200": { - "description": "Tag details", - "content": { - "application/json": { - "schema": { - "title": "details", - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - } - } - } - } - } - } - } - }, - "/tags/all": { - "get": { - "summary": "Get all tags", - "description": "Get a list of all tags.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.all", - "responses": { - "200": { - "description": "Get all tags", - "content": { - "application/json": { - "schema": { - "title": "details", - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false - } - }, - "/tags/create": { - "post": { - "summary": "Create new tag", - "description": "Create a new tag.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.create", - "responses": { - "200": { - "description": "New tag data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/tags_tagDocument_tagName" - }, - "description": { - "$ref": "#/components/schemas/tags_tagDocument_tagDescription" - } - } - } - } - } - } - } - } - } - }, - "/tags/createTags": { - "post": { - "summary": "Create many new tags", - "description": "Create multiple new tags at once.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.createTags", - "responses": { - "200": { - "description": "New tag data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/tags_tagDocument_tagName" - }, - "description": { - "$ref": "#/components/schemas/tags_tagDocument_tagDescription" - } - } - } - } - } - } - } - } - } - } - }, - "/tags/createReference": { - "post": { - "summary": "Reference a tag to a peice of content", - "description": "Create reference for tag that links it to a peice of content. This allows for content to find the tags related to it.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.createReference", - "responses": { - "200": { - "description": "New Reference Tag data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_referenceObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], - "CookieAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], - "BasicAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "tag_id": { - "$ref": "#/components/schemas/tags_tagDocument_tagId" - }, - "ref_id": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefId" - }, - "type": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefType" - } - } - } - } - } - } - } - } - } - }, - "/tags/handleReferences": { - "post": { - "summary": "Create/Update references for tags", - "description": "Create/Update references for multiple tags to a peice of content", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.handleReferences", - "responses": { - "200": { - "description": "If tag reference updates were successful.", - "content": { - "application/json": { - "schema": { - "title": "success", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], - "CookieAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"], - "BasicAuth": ["Tags.admin", "Tags.apiwrite", "Tags.engineering"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "tag_ids": { - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_tagId" - } - }, - "ref_id": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefId" - }, - "type": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefType" - } - } - } - } - } - } - } - } - } - }, - "/tags/getTagsByReference": { - "post": { - "summary": "Get Tags by content id", - "description": "Get tags for a piece of content by the content id", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.getTagsByReference", - "responses": { - "200": { - "description": "Array of tags related to reference id", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_referenceObject" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], - "CookieAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], - "BasicAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "ref_id": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefId" - } - } - } - } - } - } - } - } - } - }, - "/tags/getTagReferences": { - "post": { - "summary": "Get Tag refs by content ids", - "description": "Get tag references from multiple content ids.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.getTagReferences", - "responses": { - "200": { - "description": "Array of tags related to content ids", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_referenceObject" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], - "CookieAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"], - "BasicAuth": ["Tags.admin", "Tags.apiread", "Tags.engineering"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "title": "data", - "type": "object", - "properties": { - "ref_id": { - "type": "array", - "items": { - "$ref": "#/components/schemas/tags_tagDocument_contentRefId" - } - } - } - } - } - } - } - } - } - } - }, - "/tags/update": { - "post": { - "summary": "Updating existing tag", - "description": "Updating existing tag", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.update", - "responses": { - "200": { - "description": "Updated tag data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tag": { - "type": "object", - "title": "tag", - "properties": { - "_id": { - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - }, - "description": { - "type": "string", - "examples": ["Descriptions can be empty"] - }, - "name": { - "type": "string", - "examples": ["My Tag"] - } - } - } - } - } - } - } - } - } - }, - "/tags/duplicate": { - "post": { - "summary": "Clone existing tag", - "description": "Duplicate existing tag by cloning it and changing the name.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.duplicate", - "responses": { - "200": { - "description": "Results from duplicated tag", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "_id": { - "title": "_id", - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - } - } - } - } - } - } - } - }, - "/tags/delete": { - "post": { - "summary": "Delete existing tag", - "description": "Delete an existing tag.", - "tags": ["tags"], - "parameters": [], - "operationId": "Tags.delete", - "responses": { - "200": { - "description": "Results from deleted tag", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tags_tagDocument_tagObject" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "CookieAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ], - "BasicAuth": [ - "Tags.admin", - "Tags.other", - "Tags.readonly", - "Tags.apiread", - "Tags.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "_id": { - "title": "_id", - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - } - } - } - } - } - } - } - }, - "/workflow_engine/activate": { - "post": { - "summary": "Activate Task Worker", - "description": "Activate Task Worker", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.activate", - "responses": { - "200": { - "description": "Status flag of activation", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/jobWorker/activate": { - "post": { - "summary": "Activate the job worker", - "description": "Allow new parent jobs to be created", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.activateJobWorker", - "responses": { - "200": { - "description": "Status flag of activation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/deactivate": { - "post": { - "summary": "Deactivate Task Worker", - "description": "Deactivate Task Worker", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.deactivate", - "responses": { - "200": { - "description": "Status flag of deactivation", - "content": { - "application/json": { - "schema": { - "title": "Status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/jobWorker/deactivate": { - "post": { - "summary": "Deactivate the job worker", - "description": "Disallow new parent jobs from being created", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.deactivateJobWorker", - "responses": { - "200": { - "description": "Status flag of deactivation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/diffToHTML": { - "post": { - "summary": "diff to HTML", - "description": "Difference between two values in HTML response", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.diffToHTML", - "responses": { - "200": { - "description": "HTML difference between value1 and value2", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "string", - "examples": ["config configuration \n 3 222 \n was is "] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "label1": { - "title": "label1", - "type": "string", - "examples": ["pre"] - }, - "value1": { - "title": "value1", - "type": "string", - "examples": [ - "config\n stuff \nline 3 \ntoday was a good day" - ] - }, - "label2": { - "title": "label2", - "type": "string", - "examples": ["post"] - }, - "value2": { - "title": "value2", - "type": "string", - "examples": [ - "configuration\n stuff \nline 222 \ntoday is a good day" - ] - } - } - } - } - } - } - } - }, - "/workflow_engine/jobs/metrics": { - "get": { - "summary": "Get aggregate job metrics", - "description": "Search aggregate job metrics with options", - "tags": ["workflow_engine"], - "parameters": [ - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_order" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_sort" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" - } - }, - { - "name": "greaterThanEquals", - "in": "query", - "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", - "required": false, - "schema": { - "type": "integer", - "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", - "examples": [1617383798468, 1617383798460] - } - }, - { - "name": "greaterThanEqualsField", - "in": "query", - "description": "Date field to compare.", - "required": false, - "schema": { - "type": "string", - "description": "Date field to compare.", - "examples": ["metrics.startDate"], - "enum": ["metrics.startDate"] - } - }, - { - "name": "contains", - "in": "query", - "description": "String value to compare with containsField.", - "required": false, - "schema": { - "type": "string", - "description": "String value to compare with containsField.", - "examples": ["exampleName"] - } - }, - { - "name": "containsField", - "in": "query", - "description": "Field to compare with contains value.", - "required": false, - "schema": { - "type": "string", - "description": "Field to compare with contains value.", - "examples": ["workflow.name"], - "enum": ["workflow.name"] - } - } - ], - "operationId": "WorkFlowEngine.getJobMetrics", - "responses": { - "200": { - "description": "metrics", - "content": { - "application/json": { - "schema": { - "title": "metrics", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow_engine_taskMetricsDocument" - } - }, - "skip": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" - }, - "limit": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" - }, - "total": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/tasks/metrics": { - "get": { - "summary": "Get aggregate task metrics", - "description": "Search aggregate task metrics with options", - "tags": ["workflow_engine"], - "parameters": [ - { - "name": "order", - "in": "query", - "description": "order", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_order" - } - }, - { - "name": "sort", - "in": "query", - "description": "sort", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_sort" - } - }, - { - "name": "skip", - "in": "query", - "description": "skip", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" - } - }, - { - "name": "limit", - "in": "query", - "description": "limit", - "required": false, - "schema": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" - } - }, - { - "name": "greaterThanEquals", - "in": "query", - "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", - "required": false, - "schema": { - "type": "integer", - "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", - "examples": [1617383798468, 1617383798460] - } - }, - { - "name": "greaterThanEqualsField", - "in": "query", - "description": "Date field to compare.", - "required": false, - "schema": { - "type": "string", - "description": "Date field to compare.", - "examples": ["metrics.startDate"], - "enum": ["metrics.startDate"] - } - }, - { - "name": "equals", - "in": "query", - "description": "String value to compare with equalsField.", - "required": false, - "schema": { - "type": "string", - "description": "String value to compare with equalsField.", - "examples": ["exampleName"] - } - }, - { - "name": "equalsField", - "in": "query", - "description": "Field to compare with equals value.", - "required": false, - "schema": { - "type": "string", - "description": "Field to compare with equals value.", - "examples": ["workflow.name"], - "enum": ["workflow.name"] - } - } - ], - "operationId": "WorkFlowEngine.getTaskMetrics", - "responses": { - "200": { - "description": "metrics", - "content": { - "application/json": { - "schema": { - "title": "metrics", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow_engine_jobMetricsDocument" - } - }, - "skip": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_skip" - }, - "limit": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_limit" - }, - "total": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_total" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/workers/status": { - "get": { - "summary": "Get the current and future states of the task and job workers", - "description": "Get the current and future states of the task and job workers", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.getWorkerStatuses", - "responses": { - "200": { - "description": "Statuses of the job and task worker", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "jobWorker": { - "type": "object", - "properties": { - "running": { - "type": "boolean", - "description": "Whether the worker is currently running" - }, - "clusterValue": { - "type": "string", - "enum": ["enabled", "disabled", "not defined"], - "description": "Whether the service_config was set to enable this worker" - }, - "localValue": { - "type": "string", - "enum": ["enabled", "disabled", "not defined"], - "description": "Whether the properties.json was set to enable this worker" - }, - "startupValue": { - "type": "boolean", - "description": "Whether the clusterValue and localValue combined allow the worker to start" - } - } - }, - "taskWorker": { - "type": "object", - "properties": { - "running": { - "type": "boolean", - "description": "Whether the worker is currently running" - }, - "clusterValue": { - "type": "string", - "enum": ["enabled", "disabled", "not defined"], - "description": "Whether the service_config was set to enable this worker" - }, - "localValue": { - "type": "string", - "enum": ["enabled", "disabled", "not defined"], - "description": "Whether the properties.json was set to enable this worker" - }, - "startupValue": { - "type": "boolean", - "description": "Whether the clusterValue and localValue combined allow the worker to start" - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": false - } - }, - "/workflow_engine/active": { - "get": { - "summary": "Check Staterator State", - "description": "Check if Staterator is currently active", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.isActive", - "responses": { - "200": { - "description": "Active flag for Staterator", - "content": { - "application/json": { - "schema": { - "title": "state", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin"], - "CookieAuth": ["WorkFlowEngine.admin"], - "BasicAuth": ["WorkFlowEngine.admin"] - } - ], - "deprecated": true - } - }, - "/workflow_engine/query": { - "post": { - "summary": "Query Data Using 'json-query' Format", - "description": "Query data using a dot/bracket notation string and a matching key/value pair.", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.query", - "responses": { - "200": { - "description": "Returned data from the match query", - "content": { - "application/json": { - "schema": { - "title": "return_data", - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "object" - }, - { - "type": "array" - }, - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "examples": ["value"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "job_id": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_mongoObjectId" - }, - "pass_on_null": { - "title": "pass_on_null", - "type": "boolean" - }, - "query": { - "title": "query", - "type": "string", - "examples": ["name"] - }, - "obj": { - "title": "obj", - "type": "object", - "properties": {}, - "examples": [ - { - "name": "value" - } - ] - } - } - } - } - } - } - } - }, - "/workflow_engine/runEvaluationGroup": { - "post": { - "summary": "Evaluation", - "description": "Run a test evaluation.", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.runEvaluationGroup", - "responses": { - "200": { - "description": "Result of evaluation.", - "content": { - "application/json": { - "schema": { - "type": "boolean", - "title": "evaluation_group_value" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "evaluation_group": { - "title": "evaluation_group", - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_evaluationItem" - } - }, - "all_true_flag": { - "title": "all_true_flag", - "type": "boolean" - } - } - } - } - } - } - } - }, - "/workflow_engine/runEvaluationGroups": { - "post": { - "summary": "Evaluation Group", - "description": "Run a test evaluation group.", - "tags": ["workflow_engine"], - "parameters": [], - "operationId": "WorkFlowEngine.runEvaluationGroups", - "responses": { - "200": { - "description": "Result of evaluation.", - "content": { - "application/json": { - "schema": { - "type": "boolean", - "title": "return_value" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], - "CookieAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"], - "BasicAuth": ["WorkFlowEngine.admin", "WorkFlowEngine.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "evaluation_group": { - "title": "evaluation_group", - "type": "array", - "items": { - "type": "object", - "properties": { - "evaluations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow_engine_wfEngineCommon_evaluationItem" - } - }, - "all_true_flag": { - "type": "boolean" - } - } - } - }, - "all_true_flag": { - "title": "all_true_flag", - "type": "boolean" - } - } - } - } - } - } - } - }, - "/json-forms/forms": { - "post": { - "summary": "Creates a Json Form", - "description": "Creates a new JSON form document with a unique name.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.createForm", - "responses": { - "200": { - "description": "document that was created from the request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "title": "name", - "type": "string", - "examples": ["Device Form"] - }, - "description": { - "title": "description", - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "struct": { - "$ref": "#/components/schemas/json-forms_formStruct" - }, - "schema": { - "$ref": "#/components/schemas/json-forms_formSchema_container" - }, - "uiSchema": { - "$ref": "#/components/schemas/json-forms_formUISchema_container" - }, - "bindingSchema": { - "$ref": "#/components/schemas/json-forms_formBindingSchema_bindingSchema" - }, - "validationSchema": { - "$ref": "#/components/schemas/json-forms_formValidationSchema_validationSchema" - } - } - } - } - } - } - }, - "get": { - "summary": "Returns all forms", - "description": "Returns all JSON form documents that have previously been created.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.getForms", - "responses": { - "200": { - "description": "An array of form documents.", - "content": { - "application/json": { - "schema": { - "title": "forms", - "type": "array", - "items": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - }, - "examples": [ - [ - { - "id": "62bf2e8333385420ffe7bdd7", - "createdBy": "admin@pronoghorn", - "lastUpdatedBy": "admin@pronghorn", - "struct": { - "type": "object", - "description": "", - "items": [] - }, - "bindingSchema": {}, - "validationSchema": {}, - "tags": [], - "created": "2022-07-01T17:27:31.335Z", - "lastUpdated": "2022-07-01T17:27:31.335Z", - "name": "form-name", - "description": "", - "schema": { - "title": "form-name", - "description": "", - "type": "object", - "required": [], - "properties": {} - }, - "uiSchema": {}, - "version": "2022.1" - } - ] - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Deletes a forms", - "description": "Delete a list of JSON Forms from IAP.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.deleteForms", - "responses": { - "200": { - "description": "The status and number of delete forms.", - "content": { - "application/json": { - "schema": { - "title": "document", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "failure"] - }, - "n": { - "type": "integer" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ids": { - "title": "ids", - "type": "array", - "items": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - } - } - } - } - } - } - } - } - }, - "/json-forms/forms/{id}": { - "get": { - "summary": "Finds a form", - "description": "Finds a previously created JSON form, based on a supplied document ID.", - "tags": ["json-forms"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique name of the form", - "required": true, - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_formId" - } - } - ], - "operationId": "JsonForms.getFormById", - "responses": { - "200": { - "description": "document of requested form", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates a form", - "description": "Updates a previously created JSON form, based on a supplied document ID and an object of fields to update.", - "tags": ["json-forms"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the form.", - "required": true, - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_formId" - } - } - ], - "operationId": "JsonForms.updateForm", - "responses": { - "200": { - "description": "A response object containing the request status and a message", - "content": { - "application/json": { - "schema": { - "title": "document", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": ["success", "failure"] - }, - "message": { - "type": "string", - "examples": ["Form updated"] - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - } - } - } - } - } - } - } - }, - "/json-forms/import/forms": { - "post": { - "summary": "Import form documents", - "description": "Insert form documents into the forms collection from a user supplied JSON document.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.importForms", - "responses": { - "200": { - "description": "Status of forms import operation", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "object", - "properties": { - "status": { - "type": "string", - "const": "success" - }, - "message": { - "type": "string", - "example": "2 forms imported successfully" - }, - "imported": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "message": { - "type": "string" - }, - "original": { - "$ref": "#/components/schemas/json-forms_formDocument_importResultReport" - }, - "created": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/json-forms_formDocument_importResultReport" - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "forms": { - "title": "forms", - "type": "array", - "items": { - "$ref": "#/components/schemas/json-forms_formDocument_form" - } - } - } - } - } - } - } - } - }, - "/json-forms/validate-form/{id}": { - "post": { - "summary": "Validates form data against its schema", - "description": "Retrieves the JSON schema for a given form ID and validates the supplied form data again it.", - "tags": ["json-forms"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique ID of the form", - "required": true, - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_formId" - } - } - ], - "operationId": "JsonForms.validateForm", - "responses": { - "200": { - "description": "results from the form validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_validationResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "formData": { - "$ref": "#/components/schemas/json-forms_formDocument_formData" - } - } - } - } - } - } - } - }, - "/json-forms/validate-data": { - "post": { - "summary": "Validates data against a schema.", - "description": "Performs data validation, given a JSON schema and form data.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.validateData", - "responses": { - "200": { - "description": "results from the form validation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/json-forms_formDocument_validationResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jsonSchema": { - "$ref": "#/components/schemas/json-forms_metaSchema" - }, - "data": { - "$ref": "#/components/schemas/json-forms_formDocument_formData" - } - } - } - } - } - } - } - }, - "/json-forms/yangToSchema": { - "post": { - "summary": "Converts YANG to JSON Schema.", - "description": "onverts a list of YANG inputs into JSON Schemas", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.yangToSchema", - "responses": { - "200": { - "description": "Yang inputs converted to JSON schema", - "content": { - "application/json": { - "schema": { - "title": "jsonSchema", - "type": "array", - "items": { - "type": "object" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "yangData": { - "title": "yang", - "type": "array", - "items": { - "type": "string", - "description": "Yang module data in string format", - "examples": [ - "module Test { list interface { key \"name\"; leaf name { type string; } } }" - ] - } - } - } - } - } - } - } - } - }, - "/json-forms/decode": { - "post": { - "summary": "Decodes an encoded JSON Schema.", - "description": "Decodes an encoded JSON Schema.", - "tags": ["json-forms"], - "parameters": [], - "operationId": "JsonForms.decodeSchema", - "responses": { - "200": { - "description": "Decoded Json Schema", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "CookieAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ], - "BasicAuth": [ - "JsonForms.admin", - "JsonForms.other", - "JsonForms.readonly", - "JsonForms.apiread", - "JsonForms.operator" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jsonSchema": { - "title": "jsonSchema", - "type": "object" - } - } - } - } - } - } - } - }, - "/ag-manager/actions": { - "get": { - "summary": "Merge discovered actions from all IAG adapters", - "description": "Discovers all actions from inputed IAG adapters. This will restart this app and display a corresponding log message.", - "tags": ["ag-manager"], - "parameters": [], - "operationId": "AGManager.discoverAll", - "responses": { - "200": { - "description": "A pronghorn.json object.", - "content": { - "application/json": { - "schema": { - "title": "pronghornJson", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AGManager.admin", "AGManager.apiread"], - "CookieAuth": ["AGManager.admin", "AGManager.apiread"], - "BasicAuth": ["AGManager.admin", "AGManager.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskContinuation": { - "title": "Task Continuation", - "type": "boolean", - "default": true - } - } - } - } - } - } - }, - "delete": { - "summary": "Remove discovered actions from all IAG adapter", - "description": "Discovers all actions from all IAG adapters. This will restart this app and display a corresponding log message.", - "tags": ["ag-manager"], - "parameters": [], - "operationId": "AGManager.undiscoverAll", - "responses": { - "200": { - "description": "A pronghorn.json object.", - "content": { - "application/json": { - "schema": { - "title": "pronghornJson", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AGManager.admin", "AGManager.apiwrite"], - "CookieAuth": ["AGManager.admin", "AGManager.apiwrite"], - "BasicAuth": ["AGManager.admin", "AGManager.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskContinuation": { - "title": "Task Continuation", - "type": "boolean", - "default": true - } - } - } - } - } - } - } - }, - "/ag-manager/actions/{adapterId}": { - "get": { - "summary": "Discover actions on one IAG adapter", - "description": "Discovers all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.", - "tags": ["ag-manager"], - "parameters": [ - { - "name": "adapterId", - "in": "path", - "description": "Automation Gateway adapter ID.", - "required": true, - "schema": { - "title": "adapterId", - "type": "string" - } - } - ], - "operationId": "AGManager.discoverModules", - "responses": { - "200": { - "description": "A pronghorn.json object.", - "content": { - "application/json": { - "schema": { - "title": "pronghornJson", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AGManager.admin", "AGManager.apiread"], - "CookieAuth": ["AGManager.admin", "AGManager.apiread"], - "BasicAuth": ["AGManager.admin", "AGManager.apiread"] - } - ], - "deprecated": false - }, - "delete": { - "summary": "Remove discovered actions from one IAG adapter", - "description": "Removes all actions from a specified IAG adapter. This will restart this app and display a corresponding log message.", - "tags": ["ag-manager"], - "parameters": [ - { - "name": "adapterId", - "in": "path", - "description": "Automation Gateway adapter ID.", - "required": true, - "schema": { - "title": "adapterId", - "type": "string" - } - } - ], - "operationId": "AGManager.undiscoverModules", - "responses": { - "200": { - "description": "A pronghorn.json object.", - "content": { - "application/json": { - "schema": { - "title": "pronghornJson", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AGManager.admin", "AGManager.apiwrite"], - "CookieAuth": ["AGManager.admin", "AGManager.apiwrite"], - "BasicAuth": ["AGManager.admin", "AGManager.apiwrite"] - } - ], - "deprecated": false - } - }, - "/ag-manager/getClusterAdapters": { - "get": { - "summary": "Get all adapters in all clusters", - "description": "Get all adapters in all clusters", - "tags": ["ag-manager"], - "parameters": [], - "operationId": "AGManager.getClusterAdapters", - "responses": { - "200": { - "description": "A cluster adapter mapping object.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["AGManager.admin", "AGManager.apiread"], - "CookieAuth": ["AGManager.admin", "AGManager.apiread"], - "BasicAuth": ["AGManager.admin", "AGManager.apiread"] - } - ], - "deprecated": false - } - }, - "/workflow_builder/tasks/list": { - "get": { - "summary": "Get Tasks", - "description": "Get all Tasks.", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.getTasksList", - "responses": { - "200": { - "description": "List of all Tasks.", - "content": { - "application/json": { - "schema": { - "title": "task_list", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "location": { - "type": "string", - "enum": ["Application", "Adapter", "Broker"] - }, - "app": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "type": { - "type": "string", - "enum": ["automatic", "manual", "operation"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - } - } - }, - "deprecated": { - "type": "boolean" - } - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false - } - }, - "/workflow_builder/getTaskDetails/{app}/{task}": { - "get": { - "summary": "Get Task Details", - "description": "Get a Task's details.", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "app", - "in": "path", - "description": "Application's name (export field in model)", - "required": true, - "schema": { - "title": "app", - "type": "string", - "examples": ["ConfigurationManager"] - } - }, - { - "name": "task", - "in": "path", - "description": "Task's id (hex)", - "required": true, - "schema": { - "title": "task", - "type": "string", - "pattern": "^[0-9a-f]{1,4}$" - } - } - ], - "operationId": "WorkflowBuilder.getTaskDetails", - "responses": { - "200": { - "description": "Detailed Task.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_anyTask" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false - } - }, - "/workflow_builder/workflows/schemas": { - "post": { - "summary": "Calculate incoming/outgoing schemas for the workflow", - "description": "calculate incoming/outgoing schemas for the workflow", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.getSchemas", - "responses": { - "200": { - "description": "Input/Output transformation schemas for the workflow", - "content": { - "application/json": { - "schema": { - "title": "data", - "type": "object", - "properties": { - "inputSchema": { - "type": "object" - }, - "outputSchema": { - "type": "object" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - } - } - } - } - } - } - } - }, - "/workflow_builder/workflows/save": { - "post": { - "summary": "Add Workflow", - "description": "Add a Workflow to the database", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.saveWorkflow", - "responses": { - "200": { - "description": "The new Workflow with its data and ID.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - } - } - } - } - } - } - } - }, - "/workflow_builder/workflows/rename": { - "post": { - "summary": "Rename Workflow", - "description": "Rename a Workflow in the database", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.renameWorkflow", - "responses": { - "200": { - "description": "The renamed Workflow with its data and ID.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument" - }, - "newName": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - } - } - } - } - } - }, - "/workflow_builder/workflows/delete/{name}": { - "delete": { - "summary": "Delete Workflow", - "description": "Delete a Workflow from the database", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Workflow's name.", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.deleteWorkflow", - "responses": { - "200": { - "description": "Status of delete", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "CookieAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ], - "BasicAuth": [ - "WorkflowBuilder.admin", - "WorkflowBuilder.engineering", - "WorkflowBuilder.support" - ] - } - ], - "deprecated": false - } - }, - "/workflow_builder/workflows/{name}/groups": { - "get": { - "summary": "List Groups for a Workflow", - "description": "List the groups that have access to a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.listWorkflowGroups", - "responses": { - "200": { - "description": "List of Groups", - "content": { - "application/json": { - "schema": { - "title": "groups", - "type": "array", - "items": { - "title": "group", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "WorkflowBuilder.apiread", - "WorkflowBuilder.authorization" - ], - "CookieAuth": [ - "WorkflowBuilder.apiread", - "WorkflowBuilder.authorization" - ], - "BasicAuth": [ - "WorkflowBuilder.apiread", - "WorkflowBuilder.authorization" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Overwrite Groups for a Workflow", - "description": "Overwrite the list of groups that have access to a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.replaceWorkflowGroups", - "responses": { - "200": { - "description": "Status of Overwrite", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkflowBuilder.authorization"], - "CookieAuth": ["WorkflowBuilder.authorization"], - "BasicAuth": ["WorkflowBuilder.authorization"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "title": "groups", - "type": "array", - "items": { - "title": "group", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Add Group to Workflow", - "description": "Add a group to the list of groups for a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.createWorkflowGroupEntry", - "responses": { - "200": { - "description": "Status of Overwrite", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkflowBuilder.authorization"], - "CookieAuth": ["WorkflowBuilder.authorization"], - "BasicAuth": ["WorkflowBuilder.authorization"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "title": "group", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete all Groups for a Workflow", - "description": "Remove all authorization restriction for a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - } - ], - "operationId": "WorkflowBuilder.deleteWorkflowGroups", - "responses": { - "200": { - "description": "Status of Delete", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkflowBuilder.authorization"], - "CookieAuth": ["WorkflowBuilder.authorization"], - "BasicAuth": ["WorkflowBuilder.authorization"] - } - ], - "deprecated": false - } - }, - "/workflow_builder/workflows/{name}/groups/{group}": { - "delete": { - "summary": "Remove a Group from a Workflow", - "description": "Remove a group from the list of authorized groups for a Workflow", - "tags": ["workflow_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of Workflow", - "required": true, - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowDocument_workflowName" - } - }, - { - "name": "group", - "in": "path", - "description": "A Group Name", - "required": true, - "schema": { - "title": "group", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - ], - "operationId": "WorkflowBuilder.removeWorkflowGroup", - "responses": { - "200": { - "description": "Status of Removal", - "content": { - "application/json": { - "schema": { - "title": "status", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkflowBuilder.authorization"], - "CookieAuth": ["WorkflowBuilder.authorization"], - "BasicAuth": ["WorkflowBuilder.authorization"] - } - ], - "deprecated": false - } - }, - "/workflow_builder/export": { - "post": { - "summary": "Export Workflow", - "description": "Export a single Workflow", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.exportWorkflow", - "responses": { - "200": { - "description": "Exported Workflow", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow_builder_workflowPayload" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"], - "CookieAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"], - "BasicAuth": ["WorkflowBuilder.admin", "WorkflowBuilder.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectId", - "description": "Id of Workflow document", - "examples": [ - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "name": { - "type": "string", - "description": "The name of the workflow. When provided, 'type' can also be specified for additional filtering.", - "examples": ["ciscoIOSsoftwareUpgrade"] - }, - "type": { - "type": "string", - "description": "The type of the workflow. It is an optional field and is used in conjunction with 'name' for filtering." - } - }, - "required": ["_id", "name"], - "oneOf": [ - { - "required": ["_id"] - }, - { - "required": ["name"] - } - ], - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/workflow_builder/import": { - "post": { - "summary": "Import Workflow", - "description": "Import a single Workflow", - "tags": ["workflow_builder"], - "parameters": [], - "operationId": "WorkflowBuilder.importWorkflow", - "responses": { - "200": { - "description": "Import status Object", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "result" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["WorkflowBuilder.admin"], - "CookieAuth": ["WorkflowBuilder.admin"], - "BasicAuth": ["WorkflowBuilder.admin"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "$ref": "#/components/schemas/workflow_builder_workflowPayload" - }, - "options": { - "type": "object", - "properties": { - "adapterMap": { - "type": "object" - } - } - } - } - } - } - } - } - } - }, - "/template_builder/templates/{name}/renderJinja": { - "post": { - "summary": "Render Jinja Template", - "description": "Renders jinja template output.", - "tags": ["template_builder"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Template name", - "required": true, - "schema": { - "type": "string", - "examples": [ - "Template name 1", - "Template name 2", - "Template name 3" - ] - } - } - ], - "operationId": "TemplateBuilder.renderJinjaTemplate", - "responses": { - "200": { - "description": "Rendered jinja template", - "content": { - "application/json": { - "schema": { - "title": "renderedTemplate", - "type": "object", - "examples": [ - { - "renderedTemplate": "John was born in year 2000" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ], - "CookieAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ], - "BasicAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "object", - "examples": [ - { - "name": "John", - "DOB": "2000/1/1" - } - ] - } - } - } - } - } - } - } - }, - "/template_builder/parseTemplate": { - "post": { - "summary": "Parse templates based on the text and textfsm template sent in.", - "description": "Parse templates based on the text and textfsm template sent in.", - "tags": ["template_builder"], - "parameters": [], - "operationId": "TemplateBuilder.parseTemplate", - "responses": { - "200": { - "description": "Results from textfsm", - "content": { - "application/json": { - "schema": { - "title": "results", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ], - "CookieAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ], - "BasicAuth": [ - "TemplateBuilder.admin", - "TemplateBuilder.other", - "TemplateBuilder.readonly", - "TemplateBuilder.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/template_builder_parseTemplateInput" - } - } - } - } - } - } - } - }, - "/template_builder/applyTemplate": { - "post": { - "summary": "Apply a template to text", - "description": "Apply a template to parse text", - "tags": ["template_builder"], - "parameters": [], - "operationId": "TemplateBuilder.applyTemplate", - "responses": { - "200": { - "description": "Parsed object based on the template and text provided", - "content": { - "application/json": { - "schema": { - "title": "parsed", - "type": "object" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], - "CookieAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], - "BasicAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "text": { - "type": "string", - "examples": [ - "Template input text 1", - "Template input text 2", - "Template input text 3" - ] - }, - "template": { - "type": "string", - "examples": [ - "Template name 1", - "Template name 2", - "Template name 3" - ] - } - } - } - } - } - } - } - }, - "/template_builder/applyTemplates": { - "post": { - "summary": "Apply templates to text", - "description": "Apply templates to parse text", - "tags": ["template_builder"], - "parameters": [], - "operationId": "TemplateBuilder.applyTemplates", - "responses": { - "200": { - "description": "Parsed text based on the templates used", - "content": { - "application/json": { - "schema": { - "title": "parsed", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - [ - "Template output 1", - "Template output 2", - "Template output 3" - ] - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], - "CookieAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"], - "BasicAuth": ["TemplateBuilder.admin", "TemplateBuilder.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "text": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - [ - "Template input text 1", - "Template input text 2", - "Template input text 3" - ] - ] - }, - "templates": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - ["Template name 1", "Template name 2", "Template name 3"] - ] - } - } - } - } - } - } - } - }, - "/operations-manager/automations/clone": { - "post": { - "summary": "Clone Automation", - "description": "Clone an Automation.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.cloneAutomation", - "responses": { - "200": { - "description": "The result of the clone operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_automation-api" - }, - "metadata": { - "type": "object", - "properties": { - "automaticChanges": { - "type": "array", - "items": { - "title": "messages", - "type": "string", - "example": "Disabled trigger 628672e8f677b67b3b0f20d7" - } - }, - "triggerCloneResults": { - "type": "object", - "properties": { - "message": { - "type": "string", - "examples": ["Imported 3 of 3 document(s)."] - }, - "metadata": { - "type": "object" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "data": { - "$ref": "#/components/schemas/operations-manager_trigger-api" - }, - "automaticChanges": { - "type": "array", - "items": { - "title": "messages", - "type": "string", - "example": "Disabled trigger 628672e8f677b67b3b0f20d7" - } - } - } - } - } - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "automation", - "content": { - "application/json": { - "schema": { - "title": "automation", - "properties": { - "id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - "name": { - "description": "An optional name to use for the clone.", - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/operations-manager_common_name" - } - ] - } - } - } - } - } - } - } - }, - "/operations-manager/automations": { - "post": { - "summary": "Create Automation", - "description": "Create a new Automation.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.createAutomation", - "responses": { - "200": { - "description": "The result of the create operation.", - "content": { - "application/json": { - "schema": { - "title": "results", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - "gbac": { - "$ref": "#/components/schemas/operations-manager_automation-common_gbac" - }, - "componentId": { - "$ref": "#/components/schemas/operations-manager_automation-common_componentId" - } - } - } - ] - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "automation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_automation-create" - } - } - } - } - }, - "get": { - "summary": "Get Automations", - "description": "Search the Automation collection.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.getAutomations", - "responses": { - "200": { - "description": "The Automations that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_automation-api" - } - }, - "metadata": { - "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Import Automations", - "description": "Import Automations.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.importAutomations", - "responses": { - "200": { - "description": "The result of the import operation.", - "content": { - "application/json": { - "schema": { - "title": "status", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - "gbac": { - "$ref": "#/components/schemas/operations-manager_automation-common_gbac" - }, - "componentId": { - "$ref": "#/components/schemas/operations-manager_automation-common_componentId" - } - } - } - ] - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "automations": { - "title": "automations", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_automation-json" - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "adapterMap": { - "type": "object", - "description": "A mapping of provenance names to be converted upon import, specified in \"old_name\": \"new_name\" format.", - "examples": [ - { - "staging": "production" - }, - { - "old_name": "new_name" - } - ] - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/operations-manager/automations/{id}": { - "delete": { - "summary": "Delete Automation", - "description": "Delete an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Automation to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteAutomation", - "responses": { - "200": { - "description": "The result of the delete operation.", - "content": { - "application/json": { - "schema": { - "title": "results", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "null" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false - }, - "get": { - "summary": "Get Automation", - "description": "Get an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Automation to get.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.getAutomation", - "responses": { - "200": { - "description": "The requested Automation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_automation-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update Automation", - "description": "Update an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Automation to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.updateAutomation", - "responses": { - "200": { - "description": "The result of the update operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_automation-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - "gbac": { - "$ref": "#/components/schemas/operations-manager_automation-common_gbac" - }, - "componentId": { - "$ref": "#/components/schemas/operations-manager_automation-common_componentId" - } - } - } - ] - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_automation-update" - } - } - } - } - } - }, - "/operations-manager/automations/{id}/export": { - "get": { - "summary": "Export Automation", - "description": "Export an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Automation to export.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.exportAutomation", - "responses": { - "200": { - "description": "The result of the export operation.", - "content": { - "application/json": { - "schema": { - "title": "document", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_automation-json" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers": { - "get": { - "summary": "Get Triggers", - "description": "Search the Trigger collection.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "contains", - "in": "query", - "description": "the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document", - "required": false, - "schema": { - "type": "string", - "examples": ["event"], - "description": "the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document" - } - }, - { - "name": "containsField", - "in": "query", - "description": "the field to run a contains query on", - "required": false, - "schema": { - "type": "string", - "examples": ["name"], - "description": "the field to run a contains query on" - } - }, - { - "name": "equals", - "in": "query", - "description": "the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document", - "required": false, - "schema": { - "type": "string", - "examples": ["my event trigger"], - "description": "the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document" - } - }, - { - "name": "equalsField", - "in": "query", - "description": "the field to run an equals query on", - "required": false, - "schema": { - "type": "string", - "examples": ["name"], - "description": "the field to run an equals query on" - } - }, - { - "name": "startsWith", - "in": "query", - "description": "the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document", - "required": false, - "schema": { - "type": "string", - "examples": ["my"], - "description": "the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document" - } - }, - { - "name": "startsWithField", - "in": "query", - "description": "the field to run a startsWith query on", - "required": false, - "schema": { - "type": "string", - "examples": ["name"], - "description": "the field to run a startsWith query on" - } - }, - { - "name": "greaterThanField", - "in": "query", - "description": "the field to run a greater than query on", - "required": false, - "schema": { - "type": "string", - "examples": ["lastExecuted"], - "description": "the field to run a greater than query on" - } - }, - { - "name": "greaterThan", - "in": "query", - "description": "the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds", - "required": false, - "schema": { - "type": "string", - "examples": [ - "04/06/2021", - "Thu Dec 03 2020 14:55:00 GMT-0500 (Eastern Standard Time)", - "2020-12-03T19:55:43.189Z", - "1617681600000" - ], - "description": "the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds" - } - }, - { - "name": "lessThanField", - "in": "query", - "description": "the field to run a less than query on", - "required": false, - "schema": { - "type": "string", - "examples": ["lastExecuted"], - "description": "the field to run a less than query on" - } - }, - { - "name": "lessThan", - "in": "query", - "description": "the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds", - "required": false, - "schema": { - "type": "string", - "examples": [ - "04/06/2021", - "Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time)", - "2020-12-03T19:55:43.189Z", - "1615611600000" - ], - "description": "the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds" - } - }, - { - "name": "enabled", - "in": "query", - "description": "if true, then only return trigger documents that are enabled", - "required": false, - "schema": { - "type": "boolean", - "description": "if true, then only return trigger documents that are enabled" - } - }, - { - "name": "actionId", - "in": "query", - "description": "if provided, only return trigger documents with this action id", - "required": false, - "schema": { - "type": "string", - "description": "if provided, only return trigger documents with this action id" - } - }, - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by. Default is name.", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by. Default is name.", - "default": "name", - "enum": ["name"] - } - } - ], - "operationId": "OperationsManager.getTriggers", - "responses": { - "200": { - "description": "The Triggers that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_trigger-api" - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - }, - "post": { - "summary": "Create Trigger", - "description": "Create a new Trigger.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.createTrigger", - "responses": { - "200": { - "description": "The result of the create operation.", - "content": { - "application/json": { - "schema": { - "title": "createdTigger", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - ] - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "trigger", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_trigger-create" - } - } - } - } - }, - "put": { - "summary": "Import Triggers", - "description": "Import Triggers.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.importTriggers", - "responses": { - "200": { - "description": "The result of the import operation.", - "content": { - "application/json": { - "schema": { - "title": "createdTigger", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - ] - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "triggers": { - "title": "triggers", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_trigger-json" - } - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "adapterMap": { - "type": "object", - "description": "A mapping of provenance names to be converted upon import, specified in \"old_name\": \"new_name\" format.", - "examples": [ - { - "staging": "production" - }, - { - "old_name": "new_name" - } - ] - } - }, - "additionalProperties": false - } - } - } - } - } - } - } - }, - "/operations-manager/triggers/{id}": { - "get": { - "summary": "Get Trigger", - "description": "Get a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Trigger to get.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.getTrigger", - "responses": { - "200": { - "description": "The requested Trigger.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_trigger-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Update Trigger", - "description": "Update a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Trigger to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.updateTrigger", - "responses": { - "200": { - "description": "The result of the update operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_trigger-common_commonFields" - }, - { - "$ref": "#/components/schemas/operations-manager_common_metadataFields" - }, - { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - ] - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_trigger-update" - } - } - } - } - }, - "delete": { - "summary": "Delete Trigger", - "description": "Delete a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Trigger to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteTrigger", - "responses": { - "200": { - "description": "The result of the delete operation.", - "content": { - "application/json": { - "schema": { - "title": "success", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "null" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers/action/{id}": { - "delete": { - "summary": "Delete Triggers By Action ID", - "description": "Deletes all Triggers associated with the provided Automation id.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the parent Automation.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteTriggersByActionId", - "responses": { - "200": { - "description": "The result of the delete operation.", - "content": { - "application/json": { - "schema": { - "title": "deletedCount", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "null" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers/{id}/export": { - "get": { - "summary": "Export Trigger", - "description": "Export a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Trigger to export.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.exportTrigger", - "responses": { - "200": { - "description": "The result of the export operation.", - "content": { - "application/json": { - "schema": { - "title": "document", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_trigger-json" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/large-data/{id}": { - "get": { - "summary": "Export large data for a job or task variable", - "description": "Export large data for a job or task variable", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the job_data document in GridFS", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.exportLargeData", - "responses": { - "200": { - "description": "The requested data", - "content": { - "application/json": { - "schema": { - "title": "result", - "oneOf": [ - { - "type": "object" - }, - { - "type": "array" - }, - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "description": "The decoded job data stored in GridFS" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/events": { - "get": { - "summary": "", - "description": "Search the system events that can be used in an event Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "source", - "in": "query", - "description": "source", - "required": false, - "schema": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" - } - }, - { - "name": "topic", - "in": "query", - "description": "topic", - "required": false, - "schema": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" - } - } - ], - "operationId": "OperationsManager.getEvents", - "responses": { - "200": { - "description": "The events that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" - }, - "topic": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/events/{source}/{topic}": { - "get": { - "summary": "", - "description": "Get an event definition.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "source", - "in": "path", - "description": "source", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" - } - }, - { - "name": "topic", - "in": "path", - "description": "topic", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" - } - } - ], - "operationId": "OperationsManager.getEventDefinition", - "responses": { - "200": { - "description": "The requested event definition.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_source" - }, - "topic": { - "$ref": "#/components/schemas/operations-manager_eventSystem-trigger-common_topic" - }, - "definition": { - "type": "object", - "description": "The schema of the event.", - "$comment": "See draft 7 specification: http://json-schema.org/draft-07/schema#" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers/endpoint/{routeName}": { - "post": { - "summary": "Run Endpoint Trigger With POST", - "description": "Runs the Automation associated with the API Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "routeName", - "in": "path", - "description": "The routeName of the API Trigger.", - "required": true, - "schema": { - "title": "routeName", - "type": "string" - } - } - ], - "operationId": "OperationsManager.runEndpointTriggerWithPost", - "responses": { - "200": { - "description": "The spawned Job.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "body", - "content": { - "application/json": { - "schema": { - "title": "body", - "type": "object", - "properties": {}, - "additionalProperties": true - } - } - } - } - } - }, - "/operations-manager/triggers/manual/{id}/run": { - "post": { - "summary": "Run Manual Trigger", - "description": "Runs the Automation associated with the Manual Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Manual Trigger to run.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.runManualTrigger", - "responses": { - "200": { - "description": "The spawned Job.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "formData": { - "title": "formData", - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "runtimeOptions": { - "title": "runtimeOptions", - "default": {}, - "properties": { - "targetType": { - "enum": ["instance", "group"] - }, - "targetIdentifier": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/tasks/{taskId}/retry": { - "post": { - "summary": "Retry a task", - "description": "Retry a Task that has failed execution.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job containing the Task.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "taskId", - "in": "path", - "description": "The id of the Task to be retried.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_task-common_taskId" - } - } - ], - "operationId": "OperationsManager.retryTask", - "responses": { - "200": { - "description": "The result of the retry operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["OperationsManager.retryUser"], - "CookieAuth": ["OperationsManager.retryUser"], - "BasicAuth": ["OperationsManager.retryUser"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "variables": { - "title": "variables", - "type": "object", - "properties": {}, - "additionalProperties": true - } - } - } - } - } - } - } - }, - "/operations-manager/tasks/{taskId}/claim": { - "post": { - "summary": "Claim a task", - "description": "Assign a Task to the current user.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "taskId", - "in": "path", - "description": "The id of the Task iteration to be claimed.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_uuid-v4" - } - } - ], - "operationId": "OperationsManager.claimTask", - "responses": { - "200": { - "description": "The result of the claim operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/tasks/{taskId}/assign": { - "post": { - "summary": "Assign a task to a user", - "description": "Assign a Task to a user.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "taskId", - "in": "path", - "description": "The id of the Task iteration to be assigned.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_uuid-v4" - } - } - ], - "operationId": "OperationsManager.assignTask", - "responses": { - "200": { - "description": "The result of the assign operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "userId": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - }, - "/operations-manager/tasks/{taskId}/release": { - "post": { - "summary": "Release a currently assigned task", - "description": "Remove user assignment from a currently assigned Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "taskId", - "in": "path", - "description": "The id of the Task iteration to be released.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_uuid-v4" - } - } - ], - "operationId": "OperationsManager.releaseTask", - "responses": { - "200": { - "description": "The result of the release operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/tasks": { - "get": { - "summary": "Gets Tasks", - "description": "Search the Task collection.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of results to return. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "skip", - "in": "query", - "description": "Number of results to skip. Used for pagination.", - "required": false, - "schema": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - } - }, - { - "name": "order", - "in": "query", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "required": false, - "schema": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - } - }, - { - "name": "sort", - "in": "query", - "description": "Field to sort by", - "required": false, - "schema": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "in", - "in": "query", - "description": "Search for fields exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "not-in", - "in": "query", - "description": "Search for fields not exactly matching one of the given list options", - "required": false, - "schema": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string" - } - }, - { - "name": "equals", - "in": "query", - "description": "Returns results where the specified fields exactly match the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string" - } - }, - { - "name": "contains", - "in": "query", - "description": "Returns results where the specified fields contain the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields contain the given match string(s).", - "type": "string" - } - }, - { - "name": "starts-with", - "in": "query", - "description": "Returns results where the specified fields start with the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string" - } - }, - { - "name": "ends-with", - "in": "query", - "description": "Returns results where the specified fields end in the given match string(s).", - "required": false, - "schema": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string" - } - }, - { - "name": "dereference", - "in": "query", - "description": "Designates foreign key fields to dereference in the API output.", - "required": false, - "schema": { - "description": "Designates foreign key fields to dereference in the API output.", - "type": "string" - } - }, - { - "name": "gt", - "in": "query", - "description": "Returns results where the specified fields have values greater than the specified values.", - "required": false, - "schema": { - "description": "Returns results where the specified fields have values greater than the specified values.", - "type": "string" - } - }, - { - "name": "gte", - "in": "query", - "description": "Returns results where the specified fields have values greater than or equal to the specified values.", - "required": false, - "schema": { - "description": "Returns results where the specified fields have values greater than or equal to the specified values.", - "type": "string" - } - }, - { - "name": "lt", - "in": "query", - "description": "Returns results where the specified fields have values less than the specified values.", - "required": false, - "schema": { - "description": "Returns results where the specified fields have values less than the specified values.", - "type": "string" - } - }, - { - "name": "lte", - "in": "query", - "description": "Returns results where the specified fields have values less than or equal to the specified values.", - "required": false, - "schema": { - "description": "Returns results where the specified fields have values less than or equal to the specified values.", - "type": "string" - } - }, - { - "name": "q", - "in": "query", - "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", - "required": false, - "schema": { - "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", - "type": "string" - } - }, - { - "name": "actionableTasks", - "in": "query", - "description": "If true, only returns actionable tasks that the current user has write access to.", - "required": false, - "schema": { - "type": "boolean", - "description": "If true, only returns actionable tasks that the current user has write access to.", - "default": false - } - } - ], - "operationId": "OperationsManager.getTasks", - "responses": { - "200": { - "description": "The Tasks that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - }, - "metadata": { - "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/tasks/{id}": { - "get": { - "summary": "Get a task by ID", - "description": "Get a Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Task to get.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "dereference", - "in": "query", - "description": "Designates foreign key fields to dereference in the API output. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.", - "required": false, - "schema": { - "type": "string", - "description": "Designates foreign key fields to dereference in the API output. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.", - "examples": ["job", "accounts.metrics.owner"] - } - } - ], - "operationId": "OperationsManager.getTask", - "responses": { - "200": { - "description": "The requested Task.", - "content": { - "application/json": { - "schema": { - "title": "task", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_task-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/{jobId}/watch": { - "post": { - "summary": "Watch a Job", - "description": "Adds the current user to the list of watchers on a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to watch.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.watchJob", - "responses": { - "200": { - "description": "The result of the watch operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/unwatch": { - "post": { - "summary": "Unwatch Jobs", - "description": "Removes the current user from the list of watchers on multiple Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.unwatchJobs", - "responses": { - "200": { - "description": "The result of the unwatch operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/watch": { - "post": { - "summary": "Watch Jobs", - "description": "Adds the current user to the list of watchers on multiple Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.watchJobs", - "responses": { - "200": { - "description": "The result of the watch operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/unwatch": { - "post": { - "summary": "Unwatch Job", - "description": "Removes the current user from the list of watchers on a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to unwatch.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.unwatchJob", - "responses": { - "200": { - "description": "The result of the unwatch operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/{jobId}/add-watchers": { - "post": { - "summary": "Add watchers to a Job", - "description": "Adds user ids to the list of watchers on a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to assign watchers to.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.addWatchersToJob", - "responses": { - "200": { - "description": "The result of the add watchers operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "userIds": { - "title": "userIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/tasks/{taskId}/finish": { - "post": { - "summary": "Finish a manual task", - "description": "Work a manual Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job containing the Task to be worked.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "taskId", - "in": "path", - "description": "The id of the Task to be worked.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_job-common_taskId" - } - } - ], - "operationId": "OperationsManager.finishManualTask", - "responses": { - "200": { - "description": "The result of the finish manual Task operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskData": { - "title": "taskData", - "type": "object", - "properties": { - "finish_state": { - "type": "string" - }, - "variables": { - "type": "object" - } - }, - "required": ["finish_state", "variables"] - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/tasks/{taskId}/manual-controller": { - "get": { - "summary": "Get a client-side dialog controller for a manual task", - "description": "Get a client-side dialog controller for a manual task", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job containing the task", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "taskId", - "in": "path", - "description": "The id of the Task containing the dialog controller.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_task-common_taskId" - } - } - ], - "operationId": "OperationsManager.getManualTaskController", - "responses": { - "200": { - "description": "The requested dialog controller.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string" - }, - "decorators": { - "$ref": "#/components/schemas/operations-manager_common_decorators" - } - } - }, - "finish_state": { - "type": "string" - }, - "TaskController": { - "type": "string", - "description": "A Javascript function named TaskController." - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiread", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/{id}": { - "get": { - "summary": "Get a Job", - "description": "Get a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the Job to get.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "include", - "in": "query", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - } - }, - { - "name": "exclude", - "in": "query", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "required": false, - "schema": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - } - }, - { - "name": "dereference", - "in": "query", - "description": "Designates foreign key fields to dereference in the API output.", - "required": false, - "schema": { - "type": "string", - "description": "Designates foreign key fields to dereference in the API output.", - "examples": ["tasks", "accounts.createdBy"] - } - } - ], - "operationId": "OperationsManager.getJob", - "responses": { - "200": { - "description": "The requested Job.", - "content": { - "application/json": { - "schema": { - "title": "job", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs": { - "get": { - "summary": "Gets Jobs", - "description": "Search the Job collection.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.getJobs", - "responses": { - "200": { - "description": "The Jobs that matched the search query.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - }, - "metadata": { - "$ref": "#/components/schemas/operations-manager_common-api_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiread", - "OperationsManager.operations", - "OperationsManager.viewer" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/start": { - "post": { - "summary": "Start a Job", - "description": "Spawns a Job from a Workflow.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.startJob", - "responses": { - "200": { - "description": "The spawned Job.", - "content": { - "application/json": { - "schema": { - "title": "job", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/operations-manager_job-api" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workflow": { - "title": "workflow", - "type": "string" - }, - "options": { - "title": "options", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description for the new Job.", - "examples": ["Example job description"] - }, - "type": { - "type": "string", - "examples": ["automation"] - }, - "variables": { - "type": "object", - "description": "Variables for the new Job.", - "additionalProperties": true - }, - "groups": { - "type": "array", - "description": "GBAC for the new Job.", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/pause": { - "post": { - "summary": "Pauses Jobs", - "description": "Pause active Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.pauseJobs", - "responses": { - "200": { - "description": "The result of the pause operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/resume": { - "post": { - "summary": "Resumes Jobs", - "description": "Resumes paused Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.resumeJobs", - "responses": { - "200": { - "description": "The result of the resume operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/cancel": { - "post": { - "summary": "Cancels Jobs", - "description": "Cancel Active Jobs.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.cancelJobs", - "responses": { - "200": { - "description": "The result of the cancel operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.engineering", - "OperationsManager.apiwrite", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "type": "array", - "title": "jobIds", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/groups": { - "post": { - "summary": "Add GBAC to a Job", - "description": "Add a group id to the groups array of a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to modify.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.addJobGroup", - "responses": { - "200": { - "description": "The result of the add group operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "const": true - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groupId": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - }, - "delete": { - "summary": "Remove all GBAC from a Job", - "description": "Remove all groups from the groups array of a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to modify.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteJobGroups", - "responses": { - "200": { - "description": "The result of the delete groups operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "const": true - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Replace all GBAC from a Job with the provided list", - "description": "Replace all groups from the groups array of a Job with the provided group array.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to modify.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.replaceJobGroups", - "responses": { - "200": { - "description": "The result of the replace groups operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "const": true - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "title": "groups", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/groups/{groupId}": { - "delete": { - "summary": "Remove GBAC from a Job", - "description": "Remove a group id from the groups array of a Job.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to modify.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - }, - { - "name": "groupId", - "in": "path", - "description": "The group id to add to the Job.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteJobGroup", - "responses": { - "200": { - "description": "The result of the delete group operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "const": true - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/{jobId}": { - "delete": { - "summary": "Delete a root job and all related items", - "description": "Only succeeds on completed or cancelled root jobs. Recursively deletes children, tasks, job data, job history, and large files.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.deleteJob", - "responses": { - "200": { - "description": "The result of the delete job operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "type": "array", - "items": { - "type": "object" - } - }, - "metadata": { - "type": "object" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/jobs/delete": { - "post": { - "summary": "Deletes a list of provided root jobs and all their related items", - "description": "Only succeeds on completed or cancelled root jobs. Ignores jobs that don't fit that criteria. Recursively deletes children, tasks, job data, job history, and large files.", - "tags": ["operations-manager"], - "parameters": [], - "operationId": "OperationsManager.deleteJobs", - "responses": { - "200": { - "description": "The result of the delete jobs operation.", - "content": { - "application/json": { - "schema": { - "title": "result", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "data": { - "type": "array", - "items": { - "type": "object" - } - }, - "metadata": { - "type": "object" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jobIds": { - "title": "jobIds", - "type": "array", - "items": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/continue": { - "post": { - "summary": "Continue a Job from a specified Task", - "description": "Continue a Job from a specified Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to be continued.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.continueJobFrom", - "responses": { - "200": { - "description": "The result of the continue operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["OperationsManager.retryUser"], - "CookieAuth": ["OperationsManager.retryUser"], - "BasicAuth": ["OperationsManager.retryUser"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "fromTask": { - "$ref": "#/components/schemas/operations-manager_task-common_taskId" - } - } - } - } - } - } - } - }, - "/operations-manager/jobs/{jobId}/revert": { - "post": { - "summary": "Revert a Job", - "description": "Revert a paused Job from an errored Task to a previously completed Task.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "jobId", - "in": "path", - "description": "The id of the Job to be reverted.", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.revertJob", - "responses": { - "200": { - "description": "The result of the revert operation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering", - "OperationsManager.operations" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "fromTask": { - "$ref": "#/components/schemas/operations-manager_task-common_taskId" - }, - "toTask": { - "$ref": "#/components/schemas/operations-manager_job-common_taskId" - } - } - } - } - } - } - } - }, - "/operations-manager/automations/{automationIdentifier}/validate": { - "post": { - "summary": "Validate Automation", - "description": "Run configuration validations against an Automation.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "automationIdentifier", - "in": "path", - "description": "automationIdentifier", - "required": true, - "schema": { - "title": "automationIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/operations-manager_common_name" - } - ] - } - } - ], - "operationId": "OperationsManager.validateAutomation", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - } - }, - "warnings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false - } - }, - "/operations-manager/triggers/{triggerId}/validate": { - "post": { - "summary": "Validate Trigger", - "description": "Run configuration validations against a Trigger.", - "tags": ["operations-manager"], - "parameters": [ - { - "name": "triggerId", - "in": "path", - "description": "triggerId", - "required": true, - "schema": { - "$ref": "#/components/schemas/operations-manager_common_ObjectIdLikeString" - } - } - ], - "operationId": "OperationsManager.validateTrigger", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/operations-manager_common-api_success-response" - }, - { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - } - }, - "warnings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - } - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "CookieAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ], - "BasicAuth": [ - "OperationsManager.admin", - "OperationsManager.apiwrite", - "OperationsManager.engineering" - ] - } - ], - "deprecated": false - } - }, - "/mop/export": { - "post": { - "summary": "Export Template", - "description": "Export a single template", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.exportTemplate", - "responses": { - "200": { - "description": "Exported Template", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - }, - { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiread"], - "CookieAuth": ["MOP.admin", "MOP.apiread"], - "BasicAuth": ["MOP.admin", "MOP.apiread"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "title": "options", - "type": "object", - "examples": [ - { - "_id": "mop_test_123" - }, - { - "name": "mop_test_123" - } - ] - }, - "type": { - "title": "type", - "type": "string", - "enum": ["templates", "analytics"] - } - } - } - } - } - } - } - }, - "/mop/import": { - "post": { - "summary": "Import Template", - "description": "Import a single template", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.importTemplate", - "responses": { - "200": { - "description": "Import status", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "boolean" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "anyOf": [ - { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - }, - { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - ] - }, - "type": { - "type": "string", - "title": "type", - "enum": ["templates", "analytics"] - } - } - } - } - } - } - } - }, - "/mop/listTemplates": { - "get": { - "summary": "Get All Command Templates", - "description": "Get all Command Templates.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.listTemplates", - "responses": { - "200": { - "description": "All Command Templates.", - "content": { - "application/json": { - "schema": { - "title": "listTemplates", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false - } - }, - "/mop/listATemplate/{name}": { - "get": { - "summary": "Get a Command Template by Name", - "description": "Get a Command Template by name.", - "tags": ["mop"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the Command Template.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_name" - } - } - ], - "operationId": "MOP.listATemplate", - "responses": { - "200": { - "description": "Single Command Template matching the name.", - "content": { - "application/json": { - "schema": { - "title": "listATemplate", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false - } - }, - "/mop/listAnAnalyticTemplate/{name}": { - "get": { - "summary": "Get an Analytic Template by Name", - "description": "Get an Analytic Template by name.", - "tags": ["mop"], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the Analytic Template.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc_name" - } - } - ], - "operationId": "MOP.listAnAnalyticTemplate", - "responses": { - "200": { - "description": "Single Analytic Template wrapped in an array.", - "content": { - "application/json": { - "schema": { - "title": "listAnAnalyticTemplate", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false - } - }, - "/mop/listAnalyticTemplates": { - "get": { - "summary": "Get All Analytic Templates", - "description": "Get all Analytic Templates.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.listAnalyticTemplates", - "responses": { - "200": { - "description": "All Analytic Templates.", - "content": { - "application/json": { - "schema": { - "title": "listAnalyticTemplates", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false - } - }, - "/mop/createTemplate": { - "post": { - "summary": "Create a Command Template", - "description": "Create a Command Template.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.createTemplate", - "responses": { - "200": { - "description": "Result of the creation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mop": { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - } - } - } - } - } - } - } - }, - "/mop/createAnalyticTemplate": { - "post": { - "summary": "Create an Analytic Template", - "description": "Create an Analytic Template.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.createAnalyticTemplate", - "responses": { - "200": { - "description": "Result of the creation.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - } - } - } - } - }, - "/mop/deleteTemplate/{id}": { - "post": { - "summary": "Delete a Command Template", - "description": "Delete a Command Template by ID.", - "tags": ["mop"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of the template to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc__id" - } - } - ], - "operationId": "MOP.deleteTemplate", - "responses": { - "200": { - "description": "Status of the deletion.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false - } - }, - "/mop/deleteAnalyticTemplate/{id}": { - "post": { - "summary": "Delete an Analytic Template", - "description": "Delete an Analytic Template by ID.", - "tags": ["mop"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of the Analytic Template to delete.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc__id" - } - } - ], - "operationId": "MOP.deleteAnalyticTemplate", - "responses": { - "200": { - "description": "Status of the deletion.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false - } - }, - "/mop/updateTemplate/{mopID}": { - "post": { - "summary": "Update a Command Template", - "description": "Update a Command Template by ID.", - "tags": ["mop"], - "parameters": [ - { - "name": "mopID", - "in": "path", - "description": "ID of the Command Template to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_name" - } - }, - { - "name": "mop", - "in": "path", - "description": "Command Template to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc" - } - } - ], - "operationId": "MOP.updateTemplate", - "responses": { - "200": { - "description": "Status of the update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false - } - }, - "/mop/updateAnalyticTemplate/{mopID}": { - "post": { - "summary": "Update an Analytic Template", - "description": "Update an Analytic Template by ID.", - "tags": ["mop"], - "parameters": [ - { - "name": "mopID", - "in": "path", - "description": "ID of the Analytic Template to update.", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc__id" - } - } - ], - "operationId": "MOP.updateAnalyticTemplate", - "responses": { - "200": { - "description": "Status of the update.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_successResponse" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - } - } - } - } - }, - "/mop/RunCommandDevices": { - "post": { - "summary": "Run a Command against Devices", - "description": "Run a command against devices.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.RunCommandDevices", - "responses": { - "200": { - "description": "Result of the command run.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "command": { - "title": "command", - "type": "string", - "examples": ["show version"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - }, - "devices": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - } - } - } - } - } - } - } - }, - "/mop/RunCommand": { - "post": { - "summary": "Run a Command against a Device", - "description": "Run a command against a device.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.RunCommand", - "responses": { - "200": { - "description": "Result of the command run.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "command": { - "title": "command", - "type": "string", - "examples": ["show version"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - }, - "device": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_device" - } - } - } - } - } - } - } - }, - "/mop/RunCommandTemplate": { - "post": { - "summary": "Run Command Template", - "description": "Run a Command Template against devices.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.RunCommandTemplate", - "responses": { - "200": { - "description": "Result of the Command Template run.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template": { - "title": "template", - "type": "string", - "examples": ["show version"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - }, - "devices": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - } - } - } - } - } - } - } - }, - "/mop/RunCommandTemplateSingleCommand": { - "post": { - "summary": "Run single command from template", - "description": "Run a single command from a template on a devices.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.RunCommandTemplateSingleCommand", - "responses": { - "200": { - "description": "Result of the Command Template run.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_runCommandRes" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "templateId": { - "$ref": "#/components/schemas/mop_mopTemplateDoc__id" - }, - "commandIndex": { - "title": "commandIndex", - "type": "integer", - "examples": [0] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - }, - "devices": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - } - } - } - } - } - } - } - }, - "/mop/GetBootFlash": { - "post": { - "summary": "MOP Get Boot Flash", - "description": "Get the boot flash image", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.GetBootFlash", - "responses": { - "200": { - "description": "Binary file name currently being used by router", - "content": { - "application/json": { - "schema": { - "title": "imageName", - "type": "string", - "examples": ["10011011"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiread" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "device": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_device" - } - } - } - } - } - } - } - }, - "/mop/passThru/{device}": { - "post": { - "summary": "MOP Pass Thru", - "description": "Pass Through to execute direct device commands", - "tags": ["mop"], - "parameters": [ - { - "name": "device", - "in": "path", - "description": "device", - "required": true, - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_device" - } - } - ], - "operationId": "MOP.passThru", - "responses": { - "200": { - "description": "config", - "content": { - "application/json": { - "schema": { - "title": "config", - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "command": { - "title": "command", - "type": "string", - "examples": ["show version"] - } - } - } - } - } - } - } - }, - "/mop/deviceObjects": { - "post": { - "summary": "Get Filtered Devices", - "description": "Get the devices with name matching the given options.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.getDeviceObjectsFiltered", - "responses": { - "200": { - "description": "Filtered devices", - "content": { - "application/json": { - "schema": { - "title": "devices", - "type": "array", - "items": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_detailedDevice" - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "options": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_options" - } - } - } - } - } - } - } - }, - "/mop/devices/detailed/{substring}": { - "get": { - "summary": "Get Filtered Devices with detailed query results", - "description": "Get the devices with name matching the given string. Also returns the number of results found and number returned", - "tags": ["mop"], - "parameters": [ - { - "name": "substring", - "in": "path", - "description": "String to filter devices", - "required": true, - "schema": { - "title": "substring", - "type": "string", - "examples": ["tes"] - } - } - ], - "operationId": "MOP.getDevicesFilteredDetailedResults", - "responses": { - "200": { - "description": "Filtered devices", - "content": { - "application/json": { - "schema": { - "title": "devices", - "type": "object", - "properties": { - "num_results": { - "type": "integer" - }, - "results": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - }, - "total_results": { - "type": "integer" - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] - } - ], - "deprecated": false - } - }, - "/mop/diff": { - "post": { - "summary": "Find the diff of two config strings.", - "description": "Find the diff of two config strings.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.getDiff", - "responses": { - "200": { - "description": "Result of the diff.", - "content": { - "application/json": { - "schema": { - "title": "result", - "type": "array", - "items": { - "type": "object", - "properties": { - "count": { - "type": "number" - }, - "value": { - "type": "string" - }, - "added": { - "type": "boolean" - }, - "removed": { - "type": "boolean" - } - } - }, - "examples": [ - [ - [ - { - "count": 1, - "value": "example string\n" - }, - { - "count": 2, - "removed": true, - "value": "example string\nextra added line" - } - ] - ] - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.apiwrite"], - "CookieAuth": ["MOP.admin", "MOP.apiwrite"], - "BasicAuth": ["MOP.admin", "MOP.apiwrite"] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "value_a": { - "title": "value_a", - "type": "string", - "examples": ["any string"] - }, - "value_b": { - "title": "value_b", - "type": "string", - "examples": ["other string"] - } - } - } - } - } - } - } - }, - "/mop/runTemplatesDiffArray": { - "post": { - "summary": "MOP Diff Array", - "description": "Generates a diff for the input. By default, the API call timeout is 5 minutes for the platform. If this API call needs additional time, it can be modified in the Express timeout property. The supported timeout range would be a minimum of 8 minutes for a 2MB payload and a maximum of 32 minutes for a 4MB payload.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.runTemplatesDiffArray", - "responses": { - "200": { - "description": "diff", - "content": { - "application/json": { - "schema": { - "title": "diff", - "type": "object", - "properties": { - "onlyPre": { - "type": "object", - "properties": {} - }, - "diff": { - "type": "object", - "properties": {} - }, - "onlyPost": { - "type": "object", - "properties": {} - }, - "analytics": { - "type": "object", - "properties": {} - } - } - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ] - } - ], - "deprecated": true, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pre": { - "title": "pre", - "type": "array", - "items": { - "type": "string", - "examples": ["show version"] - } - }, - "post": { - "title": "post", - "type": "array", - "items": { - "type": "string", - "examples": ["show version"] - } - } - } - } - } - } - } - } - }, - "/mop/runAnalyticsTemplate": { - "post": { - "summary": "Run an Analytics Template", - "description": "Run an Analytic Template.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.runAnalyticsTemplate", - "responses": { - "200": { - "description": "Result of running Analytic Template", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pre": { - "title": "pre", - "type": "object", - "properties": { - "command": { - "type": "string" - }, - "commands_results": { - "type": "string" - } - }, - "examples": [ - { - "command": "show version", - "commands_results": "Cisco IOS Software, Version 1.2.3" - } - ] - }, - "post": { - "title": "post", - "type": "object", - "properties": { - "command": { - "type": "string" - }, - "commands_results": { - "type": "string" - } - }, - "examples": [ - { - "command": "show version", - "commands_results": "Cisco IOS Software, Version 1.2.3" - } - ] - }, - "analytic_template_name": { - "title": "analytic_template_name", - "type": "string", - "examples": ["test"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - } - } - } - } - } - } - } - }, - "/mop/runAnalyticsTemplateDevices": { - "post": { - "summary": "Run an Analytics Template for Devices", - "description": "Run an Analytic Template for Devices.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.runAnalyticsTemplateDevices", - "responses": { - "200": { - "description": "Result of running Analytic Template Devices", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopAnalyticTemplateDoc" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pre": { - "title": "pre", - "type": "object", - "properties": { - "pre": { - "type": "object", - "properties": { - "commands_results": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["commands_results"], - "additionalProperties": false - } - } - }, - "post": { - "title": "post", - "type": "object", - "properties": { - "post": { - "type": "object", - "properties": { - "commands_results": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["commands_results"], - "additionalProperties": false - } - } - }, - "analytic_template_name": { - "title": "analytic_template_name", - "type": "string", - "examples": ["test"] - }, - "variables": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_variables" - } - } - } - } - } - } - } - }, - "/mop/reattempt": { - "post": { - "summary": "Retry a task automatically for x number of attempts with n minute intervals.", - "description": "Workflow will follow reattempt task's outgoing transition after n minutes of delay.", - "tags": ["mop"], - "parameters": [], - "operationId": "MOP.reattempt", - "responses": { - "200": { - "description": "Response from attempt", - "content": { - "application/json": { - "schema": { - "title": "response", - "type": "string", - "examples": ["Success"] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "CookieAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ], - "BasicAuth": [ - "MOP.admin", - "MOP.engineering", - "MOP.support", - "MOP.apiwrite" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "job_id": { - "title": "job_id", - "type": "string", - "examples": ["test"] - }, - "attemptID": { - "title": "attemptID", - "type": "string", - "examples": ["test1234"] - }, - "minutes": { - "title": "minutes", - "type": "integer", - "examples": [1] - }, - "attempts": { - "title": "attempts", - "type": "integer", - "examples": [2] - } - } - } - } - } - } - } - }, - "/mop/devices/{substring}": { - "get": { - "summary": "Get Filtered Devices", - "description": "Get the devices with name matching the given string.", - "tags": ["mop"], - "parameters": [ - { - "name": "substring", - "in": "path", - "description": "String to filter devices", - "required": true, - "schema": { - "title": "substring", - "type": "string", - "examples": ["tes"] - } - } - ], - "operationId": "MOP.getDevicesFiltered", - "responses": { - "200": { - "description": "Filtered devices", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/mop_mopTemplateDoc_devices" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "CookieAuth": ["MOP.admin", "MOP.engineering", "MOP.support"], - "BasicAuth": ["MOP.admin", "MOP.engineering", "MOP.support"] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/action-executions/{executionId}/cancel": { - "post": { - "summary": "Cancels an action execution", - "description": "Cancels an action execution, if targeting a bulk action execution, all its child executions will also be canceled.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "executionId", - "in": "path", - "description": "executionId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.cancelActionExecution", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/groups": { - "post": { - "summary": "Creates a new instance group", - "description": "Creates a new instance group", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.createInstanceGroupHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "instanceGroup", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-create" - } - } - } - } - }, - "get": { - "summary": "Gets multiple instance groups", - "description": "Gets multiple instance groups", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.getInstanceGroupsHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" - } - }, - "metadata": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources": { - "post": { - "summary": "Creates a new resource model", - "description": "Creates a new resource model", - "tags": ["lifecycle-manager"], - "parameters": [], - "operationId": "LifecycleManager.createResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "resourceModelData", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-create-data" - } - } - } - } - }, - "get": { - "summary": "Searches resource models", - "description": "Searches resource models", - "tags": ["lifecycle-manager"], - "parameters": [], - "operationId": "LifecycleManager.getResourceModelsHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" - } - }, - "metadata": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/groups/{groupIdentifier}": { - "delete": { - "summary": "Deletes an instance group", - "description": "Deletes an instance group", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - }, - { - "name": "groupIdentifier", - "in": "path", - "description": "groupIdentifier", - "required": true, - "schema": { - "title": "groupIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.deleteInstanceGroupHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - }, - "get": { - "summary": "Gets a single instance group", - "description": "Gets a single new instance group", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - }, - { - "name": "groupIdentifier", - "in": "path", - "description": "groupIdentifier", - "required": true, - "schema": { - "title": "groupIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.getInstanceGroupHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - }, - "patch": { - "summary": "Updates a instance group", - "description": "Updates a instance group", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - }, - { - "name": "groupIdentifier", - "in": "path", - "description": "groupIdentifier", - "required": true, - "schema": { - "title": "groupIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.updateInstanceGroupHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_instance-group-update" - } - } - } - } - } - }, - "/lifecycle-manager/resources/{id}": { - "delete": { - "summary": "Deletes a resource model", - "description": "A resource model will not be deleted if it has associated instances. To override this behavior and delete the resource model along with any associated instances, set the 'delete-associated-instances' flag to 'true'.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" - } - } - ], - "operationId": "LifecycleManager.deleteResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "queryParameters": { - "title": "queryParameters", - "type": "object", - "properties": { - "delete-associated-instances": { - "description": "If set to 'true', the resource model and any of its associated instances will be deleted.", - "type": "string" - } - }, - "required": [] - } - } - } - } - } - } - }, - "get": { - "summary": "Gets a resource model based on id", - "description": "Gets a resource model based on id", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ObjectId of the resource model", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" - } - }, - { - "name": "dereference", - "in": "query", - "description": "dereference", - "required": false, - "schema": { - "type": "string" - } - } - ], - "operationId": "LifecycleManager.getResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates a resource model", - "description": "Updates a resource model", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectId" - } - } - ], - "operationId": "LifecycleManager.updateResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "title": "updates", - "type": "object", - "properties": {} - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelId}/edit": { - "post": { - "summary": "Performs edits to a resource model", - "description": "Performs edits to a resource model. This method exists to support specific resource edit activities required by the UI.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "Resource model ID", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.editResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "properties", - "content": { - "application/json": { - "schema": { - "title": "properties", - "oneOf": [ - { - "type": "object", - "required": ["command", "action"], - "properties": { - "command": { - "type": "string", - "description": "Edit command to execute", - "enum": [ - "generate-action-workflow", - "generate-action-pre-transformation", - "generate-action-post-transformation" - ] - }, - "action": { - "description": "Resource action ID or pending action definition", - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action" - } - ] - }, - "overwrite": { - "description": "Tells the component generator to either disregard and overwrite an existing component on the action (when true) or to refuse to generate a new component (when false).", - "type": "boolean" - }, - "updateAction": { - "description": "Tells the component generator to either update the action in the database (when true) or to only generate and return the new component (when false)", - "type": "boolean" - } - } - } - ] - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/instances/{instanceIdentifier}/export": { - "get": { - "summary": "Exports a resource instance", - "description": "This method exports a resource instance.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - }, - { - "name": "instanceIdentifier", - "in": "path", - "description": "instanceIdentifier", - "required": true, - "schema": { - "title": "instanceIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.exportResourceInstanceHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-export" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelId}/export": { - "get": { - "summary": "Exports a resource model", - "description": "This method exports a resource model.", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "modelId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.exportResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": true, - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-export" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/action-executions/{id}": { - "get": { - "summary": "Gets a single action execution record", - "description": "Gets a single action execution record", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.getActionExecution", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": true, - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/action-executions": { - "get": { - "summary": "Searches resource action history documents", - "description": "Searches resource action history documents", - "tags": ["lifecycle-manager"], - "parameters": [], - "operationId": "LifecycleManager.getActionExecutions", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": true, - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_resource-action-execution-http" - } - }, - "metadata": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelId}/instances/{instanceId}": { - "get": { - "summary": "Gets a single resource instance", - "description": "Gets a single resource instance", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "modelId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - }, - { - "name": "instanceId", - "in": "path", - "description": "The identifier of the resource instance", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.getResourceInstanceHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer", - "LifecycleManager.operator" - ] - } - ], - "deprecated": false - }, - "put": { - "summary": "Updates the `name` and `description` fields of a resource instance", - "description": "Updates the `name` and `description` fields of a resource instance", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "modelId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - }, - { - "name": "instanceId", - "in": "path", - "description": "instanceId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.updateInstanceMetadataHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "updates", - "content": { - "application/json": { - "schema": { - "title": "updates", - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_name" - }, - "description": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_description" - } - } - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelId}/instances": { - "get": { - "summary": "Searches resource instances", - "description": "Searches resource instances", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "modelId", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.getResourceInstancesHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - }, - "metadata": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_pagination-metadata" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/instances/import": { - "post": { - "summary": "Imports an instance into a resource", - "description": "Imports an instance into a resource", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "modelIdentifier", - "required": true, - "schema": { - "title": "modelIdentifier", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - } - } - ], - "operationId": "LifecycleManager.importResourceInstanceHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "instance", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-export" - } - } - } - } - } - }, - "/lifecycle-manager/resources/import": { - "post": { - "summary": "Imports a resource model", - "description": "Imports a resource model", - "tags": ["lifecycle-manager"], - "parameters": [], - "operationId": "LifecycleManager.importResourceModelHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - }, - { - "type": "object", - "additionalProperties": true, - "properties": { - "data": { - "type": "object", - "additionalProperties": false, - "properties": { - "_id": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - }, - "name": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_name" - } - } - } - } - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "importParameters", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-import" - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelId}/run-action": { - "post": { - "summary": "Runs a resource action", - "description": "Runs a resource action", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "The ID of the Resource Model to run an action on", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.runActionHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "required": ["actionId"], - "additionalProperties": false, - "properties": { - "actionId": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" - }, - "instance": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-http" - } - ] - }, - "instanceName": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_name" - }, - "instanceDescription": { - "$ref": "#/components/schemas/lifecycle-manager_resource-instance-common_description" - }, - "inputs": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelIdentifier}/run-bulk-action": { - "post": { - "summary": "Runs a resource action against multiple instances", - "description": "Runs a resource action against multiple instances", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelIdentifier", - "in": "path", - "description": "The ID of the Resource Model to run an action on.", - "required": true, - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_name" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - ] - } - } - ], - "operationId": "LifecycleManager.runBulkActionHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiwrite", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "options", - "content": { - "application/json": { - "schema": { - "title": "options", - "type": "object", - "required": ["actionId"], - "additionalProperties": false, - "properties": { - "actionId": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_action-identifier" - }, - "group": { - "title": "groupIdentifier", - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common_ObjectIdLikeString" - }, - { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - ] - }, - "instances": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lifecycle-manager_common_name" - } - }, - "inputs": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "inputOverrides": { - "oneOf": [ - { - "type": "array" - }, - { - "type": "null" - } - ] - } - } - } - } - } - } - } - }, - "/lifecycle-manager/resources/{modelId}/actions/validate": { - "post": { - "summary": "Validates the actions defined on a resource model", - "description": "This method validates the actions on a resource model. Each validation report has an associate severity, and designates whether or not it will prevent the action from saving, prevent the model from running, or both. It accepts pending edits to actions in the optional 'actions' body parameter in order to check for validation issues on unsaved, pending changes to an action", - "tags": ["lifecycle-manager"], - "parameters": [ - { - "name": "modelId", - "in": "path", - "description": "Resource model ID", - "required": true, - "schema": { - "$ref": "#/components/schemas/lifecycle-manager_common-http_document-identifier" - } - } - ], - "operationId": "LifecycleManager.validateActionsHttp", - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "response", - "allOf": [ - { - "$ref": "#/components/schemas/lifecycle-manager_common-http_response" - } - ] - } - } - } - }, - "500": { - "description": "Error response from API" - } - }, - "security": [ - { - "QueryAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "CookieAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ], - "BasicAuth": [ - "LifecycleManager.admin", - "LifecycleManager.apiread", - "LifecycleManager.designer" - ] - } - ], - "deprecated": false, - "requestBody": { - "description": "properties", - "content": { - "application/json": { - "schema": { - "title": "properties", - "type": "object", - "required": [], - "properties": { - "actions": { - "$ref": "#/components/schemas/lifecycle-manager_resource-model-common_actions" - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "iap_accounts-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Account Schema", - "description": "This is the schema for an IAP account stored in Mongo", - "properties": { - "provenance": { - "title": "Provenance", - "description": "AAA provider where account originated", - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "title": "Username", - "description": "Username for account", - "type": "string", - "examples": ["john_doe"] - }, - "firstname": { - "title": "First Name", - "description": "The user's first name", - "type": "string", - "examples": ["John"] - }, - "memberOf": { - "title": "Assigned Groups", - "description": "Groups which this account is a part of", - "type": "array", - "items": { - "type": "object", - "properties": { - "aaaManaged": { - "description": "Whether group comes from an external AAA or not", - "type": "boolean" - }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "assignedRoles": { - "title": "Assigned Roles", - "description": "Roles assigned to this account", - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - }, - "additionalProperties": false - } - }, - "inactive": { - "title": "Inactive", - "description": "Setting for whether account is active or not", - "type": "boolean" - }, - "lastLogin": { - "title": "Last Login", - "description": "Date and time when the user last logged in", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "sso": { - "title": "sso", - "description": "Whether this is an SSO user", - "type": "boolean" - }, - "nameID": { - "title": "nameID", - "description": "Identifier for SSO account.", - "type": "string" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "title": "Created", - "description": "When the account was created", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updated": { - "title": "Updated", - "description": "When the account was last updated", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - } - } - }, - "email": { - "title": "Email", - "description": "Email for user", - "type": "string", - "examples": ["name@email.com"] - }, - "isServiceAccount": { - "description": "Value denoting if an account does not reflect a human user", - "type": "boolean" - }, - "loggedIn": { - "description": "Property used in the getAccounts API to indicate a user is currently logged in", - "type": "boolean" - }, - "gitTokens": { - "description": "Tokens used when interacting with Git APIs and features", - "type": "object", - "properties": { - "GitHub": { - "description": "Personal access token for GitHub", - "type": "string" - }, - "GitLab": { - "description": "Personal access token for GitLab", - "type": "string" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false, - "required": [ - "provenance", - "username", - "firstname", - "memberOf", - "assignedRoles", - "inactive", - "gitTokens" - ] - }, - "iap_accounts-schema_username": { - "title": "Username", - "description": "Username for account", - "type": "string", - "examples": ["john_doe"] - }, - "iap_accounts-schema_inactive": { - "title": "Inactive", - "description": "Setting for whether account is active or not", - "type": "boolean" - }, - "iap_accounts-schema_memberOf": { - "title": "Assigned Groups", - "description": "Groups which this account is a part of", - "type": "array", - "items": { - "type": "object", - "properties": { - "aaaManaged": { - "description": "Whether group comes from an external AAA or not", - "type": "boolean" - }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "iap_accounts-schema_assignedRoles": { - "title": "Assigned Roles", - "description": "Roles assigned to this account", - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - }, - "additionalProperties": false - } - }, - "iap_accounts-schema_email": { - "title": "Email", - "description": "Email for user", - "type": "string", - "examples": ["name@email.com"] - }, - "iap_accounts-schema_isServiceAccount": { - "description": "Value denoting if an account does not reflect a human user", - "type": "boolean" - }, - "iap_accounts-schema_loggedIn": { - "description": "Property used in the getAccounts API to indicate a user is currently logged in", - "type": "boolean" - }, - "iap_accounts-schema_gitTokens": { - "description": "Tokens used when interacting with Git APIs and features", - "type": "object", - "properties": { - "GitHub": { - "description": "Personal access token for GitHub", - "type": "string" - }, - "GitLab": { - "description": "Personal access token for GitLab", - "type": "string" - } - }, - "additionalProperties": false - }, - "iap_common-schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Common schema definitions" - }, - "iap_common-schema_status": { - "type": "string", - "description": "The status of the API request.", - "enum": ["OK", "Created"] - }, - "iap_common-schema_message": { - "type": "string", - "description": "Message containing either confirmation of the operation or the reason for the failure of the operation.", - "examples": ["A sample success message"] - }, - "iap_common-schema_limit": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - }, - "iap_common-schema_skip": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - }, - "iap_common-schema_order": { - "type": "integer", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "default": 1, - "enum": [-1, 1] - }, - "iap_common-schema_sort": { - "type": "string", - "description": "Field to sort by. Default is name.", - "default": "name", - "enum": ["name"] - }, - "iap_common-schema_isActive": { - "type": "boolean", - "description": "Is profile the active profile.", - "examples": [true, false] - }, - "iap_common-schema_activeSync": { - "type": "boolean", - "description": "Is active profile in sync with the system.", - "examples": [true, false] - }, - "iap_common-schema_enabled": { - "type": "boolean", - "description": "A flag that denotes if the repository configuration is connected", - "enum": [true, false] - }, - "iap_common-schema_total": { - "type": "integer", - "description": "The total number of documents", - "minimum": 0, - "examples": [1, 5, 10, 20, 50] - }, - "iap_common-schema_type": { - "type": "string", - "description": "The type of Repository", - "enum": ["gitlab"] - }, - "iap_common-schema_hostname": { - "type": "string", - "description": "The hostname of the Respository endpoint", - "examples": ["gitlab.com"] - }, - "iap_common-schema_path": { - "type": "string", - "description": "The path of the Repository endpoint", - "examples": ["itentialopensource/pre-built-automations"] - }, - "iap_common-schema_credentials": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "An access token used to make HTTP requests", - "examples": ["uTc_P4pnMAEsLbQHmyOt"] - } - }, - "additionalProperties": false - }, - "iap_common-schema_config": { - "type": "string", - "description": "The name of the repository configuration that will be used to fetch Prebuilts", - "examples": ["@itentialopensource"] - }, - "iap_common-schema_objectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "iap_decorators-schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/redisProps/password"] - } - } - } - }, - "iap_indexes-schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "key": { - "type": "object", - "examples": [ - { - "name": 1 - } - ], - "additionalProperties": { - "type": "integer", - "enum": [-1, 1] - } - }, - "name": { - "type": "string", - "examples": ["name_1"] - }, - "background": { - "type": "boolean", - "enum": [true] - }, - "unique": { - "type": "boolean" - } - }, - "required": ["key", "background"] - }, - "iap_prebuilts-schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "@itentialopensource/aggregate-functions-for-arrays", - "@itentialopensource/cisco-nx-upgrade" - ] - }, - "version": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - }, - "description": { - "type": "string", - "examples": ["A basic description"] - }, - "author": { - "type": "string", - "examples": ["Itential Artifacts"] - }, - "license": { - "type": "string", - "examples": ["Apache-2.0"] - }, - "repository": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["local", "gitlab", "git"] - }, - "hostname": { - "type": "string", - "examples": ["gitlab.com", "localhost"] - }, - "path": { - "type": "string", - "examples": ["/itentialopensource/pre-built-automations"] - } - }, - "required": ["type"] - }, - "keywords": { - "type": "array", - "items": { - "type": "string", - "examples": ["Itential"] - } - }, - "IAPDependencies": { - "type": "object" - }, - "gitlabId": { - "type": "integer", - "examples": [17866482] - } - }, - "required": [ - "name", - "version", - "description", - "author", - "license", - "repository", - "IAPDependencies" - ], - "additionalProperties": false - }, - "manifest": { - "type": "object", - "properties": { - "bundleName": { - "type": "string", - "examples": ["aggregateFunctions"] - }, - "fingerprint": { - "type": "string", - "examples": ["5e84f892c5eab11ec2eee16d"] - }, - "createdEpoch": { - "type": "string", - "examples": ["1585772690392"] - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "examples": ["5e5ea3bd16da51d52b4a8f9f"] - }, - "name": { - "type": "string", - "examples": ["aggregateFunctions"] - }, - "type": { - "type": "string", - "enum": [ - "automation", - "forms", - "golden-config", - "integration", - "integration-model", - "json-forms", - "mop-template", - "mop-analytic-template", - "template", - "transformation", - "workflow" - ] - }, - "location": { - "type": "string", - "examples": [ - "/bundles/workflows/IAP Test Artifact Workflow.json" - ] - } - } - } - } - }, - "required": ["bundleName", "artifacts"], - "additionalProperties": false - }, - "bundles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "automation", - "forms", - "golden-config", - "integration", - "integration-model", - "json-forms", - "mop-template", - "mop-analytic-template", - "template", - "transformation", - "workflow" - ] - }, - "data": { - "type": "object" - } - }, - "required": ["type", "data"], - "additionalProperties": false - } - }, - "readme": { - "type": "string", - "examples": ["example of readme"], - "pattern": "^([\\S\\s]*)$" - } - }, - "required": ["metadata", "manifest", "bundles", "readme"], - "additionalProperties": false - }, - "iap_prebuilts-schema_readme": { - "type": "string", - "examples": ["example of readme"], - "pattern": "^([\\S\\s]*)$" - }, - "iap_prebuilts-schema_name": { - "type": "string", - "examples": [ - "@itentialopensource/aggregate-functions-for-arrays", - "@itentialopensource/cisco-nx-upgrade" - ] - }, - "iap_prebuilts-schema_version": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - }, - "iap_prebuilts-schema_description": { - "type": "string", - "examples": ["A basic description"] - }, - "iap_prebuilts-schema_author": { - "type": "string", - "examples": ["Itential Artifacts"] - }, - "iap_prebuilts-schema_license": { - "type": "string", - "examples": ["Apache-2.0"] - }, - "iap_prebuilts-schema_repository": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["local", "gitlab", "git"] - }, - "hostname": { - "type": "string", - "examples": ["gitlab.com", "localhost"] - }, - "path": { - "type": "string", - "examples": ["/itentialopensource/pre-built-automations"] - } - }, - "required": ["type"] - }, - "iap_prebuilts-schema_keywords": { - "type": "array", - "items": { - "type": "string", - "examples": ["Itential"] - } - }, - "iap_prebuilts-schema_IAPDependencies": { - "type": "object" - }, - "iap_profiles-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "The root schema", - "description": "The root schema comprises the entire JSON document.", - "properties": { - "uiProps": { - "type": "object", - "title": "UI Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["UI"] - }, - "layout": { - "type": "string", - "title": "Layout", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/layout.jade" - ] - }, - "home": { - "type": "string", - "title": "Home", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/home.jade" - ] - }, - "login": { - "type": "string", - "title": "Login", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/login.jade" - ] - }, - "profile": { - "type": "string", - "title": "Profile", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/profile.jade" - ] - }, - "fav_icon": { - "type": "string", - "title": "Favicon", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/img/favicon.ico" - ] - } - } - }, - "authenticationProps": { - "type": "object", - "title": "Authentication Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Authentication"] - }, - "logoutTime": { - "type": "integer", - "minimum": 2, - "description": "The maximum number of time IAP has to make an api call before the user is logged out, in minutes.", - "title": "Logout Time", - "examples": [20] - }, - "uniqueSession": { - "type": "boolean", - "description": "When uniqueSession is set to true, only one session may be enabled for a given user.", - "title": "Unique Session", - "examples": [false] - }, - "admins": { - "type": "array", - "title": "Admins", - "description": "Members of these groups will be implicitly assigned with admin permissions", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "description": "The name of the AAA adapter in which the groups reside.", - "title": "Provenance", - "examples": ["Local AAA"] - }, - "group": { - "type": "string", - "description": "The name of a user group which will have Pronghorn user management capabilities.", - "title": "Group", - "examples": ["admin"] - } - } - } - }, - "cookieName": { - "type": "string", - "description": "The name used by Pronghorn to identify cookies for user session data", - "title": "Cookie Name", - "examples": ["pronghorn_token"] - }, - "brokerPrincipal": { - "type": "boolean", - "description": "When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal.", - "title": "Broker Principal", - "examples": [false] - } - } - }, - "expressProps": { - "type": "object", - "title": "Express Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Express Server"] - }, - "cacheControl": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers.", - "title": "Cache Control", - "examples": [false] - }, - "timeout": { - "type": "integer", - "description": "The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client.", - "title": "Timeout", - "examples": [300000] - }, - "access_control_allow_origin": { - "type": "string", - "description": "The configured domain name for the Access-Control-Allow-Origin header used for security.", - "title": "Access-Control-Allow-Origin", - "examples": ["*"] - }, - "express_http": { - "type": "object", - "title": "Express HTTP Settings", - "properties": { - "enable": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests.", - "title": "Enable HTTP", - "examples": [false] - }, - "port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - } - } - }, - "express_https": { - "type": "object", - "title": "Express HTTPS Settings", - "properties": { - "enable": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests.", - "title": "Enable HTTPS", - "examples": [true] - }, - "port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - }, - "key": { - "type": "string", - "description": "The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property.", - "title": "Key", - "examples": ["/opt/pronghorn/current/keys/key.pem"] - }, - "passphrase": { - "type": "string", - "title": "Passphrase", - "description": "The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase." - }, - "cert": { - "type": "string", - "title": "Certificate", - "description": "The server's public certificate to use for all HTTPS transactions.", - "examples": ["/opt/pronghorn/current/keys/cert.pem"] - }, - "secureProtocol": { - "type": "string", - "description": "The secureProtocol can be used to configure the set of allowed SSL/TLS protocol versions.", - "title": "Secure Protocol", - "examples": ["TLSv1_2_method"], - "enum": ["TLSv1_method", "TLSv1_1_method", "TLSv1_2_method"] - }, - "ciphers": { - "type": "string", - "description": "The set of ciphers to allow when establishing an encrypted session.", - "title": "Ciphers", - "examples": [ - "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" - ] - }, - "client_reneg_limit": { - "type": "integer", - "description": "The maximum number of client renegotiations allowed per renegotiation window.", - "title": "Client Renegotiation Limit", - "examples": [1] - }, - "client_reneg_window": { - "type": "integer", - "description": "The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds.", - "title": "Client Renegotiation Window", - "examples": [600] - } - } - }, - "allowedHttpOptionalVerbs": { - "title": "Allowed HTTP Optional Verbs", - "description": "An array of optional HTTP verbs that are allowed to be used in requests to IAP", - "type": "array", - "uniqueItems": true, - "items": { - "enum": [ - "ACL", - "BIND", - "CHECKOUT", - "CONNECT", - "COPY", - "LINK", - "LOCK", - "MERGE", - "MKACTIVITY", - "MKCALENDAR", - "MKCOL", - "MOVE", - "M-SEARCH", - "NOTIFY", - "PROPFIND", - "PROPPATCH", - "PURGE", - "REBIND", - "REPORT", - "SEARCH", - "SUBSCRIBE", - "TRACE", - "UNBIND", - "UNLINK", - "UNLOCK", - "UNSUBSCRIBE" - ] - } - } - } - }, - "loggerProps": { - "type": "object", - "title": "Logger Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Logging"] - }, - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store Pronghorn log files.", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name of the current Pronghorn log file.", - "title": "Filename", - "examples": ["pronghorn.log"] - }, - "log_max_file_size": { - "type": "integer", - "title": "Max File Size", - "description": "The maximum size of each Pronghorn log file in bytes.", - "examples": [1048576] - }, - "log_max_files": { - "type": "integer", - "description": "The maximum number of log files maintained on the server.", - "title": "Max Number of Files", - "examples": [100] - }, - "log_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "console_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "webserver": { - "type": "object", - "description": "Determines how to set up the web server access log.", - "title": "Webserver", - "properties": { - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store web server access log files.", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name for the web server access log file.", - "title": "Filename", - "examples": ["webserver.log"] - } - } - }, - "syslog": { - "type": "object", - "description": "Allows Pronghorn to send log messages to a local or remote syslog daemon.", - "title": "Syslog", - "properties": { - "level": { - "type": "string", - "title": "Sys Log Level", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "host": { - "type": "string", - "description": "The host running syslogd.", - "title": "Host", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "description": "The port on the host that syslog is running on.", - "title": "Port", - "minimum": 1, - "maximum": 65535, - "examples": [514] - }, - "protocol": { - "type": "string", - "title": "Protocol", - "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", - "examples": ["udp4"], - "enum": ["tcp4", "udp4", "unix", "unix-connect"] - }, - "facility": { - "type": "string", - "description": "The syslog facility to use.", - "title": "Facility", - "examples": ["local0"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", - "examples": ["5424"], - "enum": ["BSD", "5424"] - }, - "path": { - "type": "string", - "title": "Path", - "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured.", - "format": "uri-reference", - "examples": ["/dev/log"] - }, - "pid": { - "type": "string", - "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", - "title": "Process ID", - "examples": ["process.pid"] - }, - "localhost": { - "type": "string", - "description": "The host to indicate that log messages are coming from.", - "title": "Log Host", - "examples": ["localhost"] - }, - "app_name": { - "type": "string", - "description": "The name of the application.", - "title": "Application Name", - "examples": ["process.title"] - }, - "eol": { - "type": "string", - "title": "End of Line Character", - "description": "The end of line character to be added to the end of the message.", - "examples": ["CR"] - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "redisProps": { - "type": "object", - "title": "Redis Properties", - "properties": { - "db": { - "type": "integer", - "description": "The Redis database number to connect to (may be any of 0-15).", - "title": "Database Number", - "examples": [0], - "minimum": 0 - }, - "username": { - "type": "string", - "title": "Username", - "description": "The username with access to the Redis DB.", - "examples": ["admin"] - }, - "password": { - "type": "string", - "title": "Password", - "description": "The passphrase protecting access to the Redis DB.", - "examples": [ - "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e" - ] - }, - "maxRetriesPerRequest": { - "type": "integer", - "description": "IAP will be shutdown after maxRetriesPerRequest is reached in case of lost Redis network connection.", - "title": "Max Retries Per Request", - "examples": [20] - }, - "maxHeartbeatWriteRetries": { - "type": "integer", - "description": "IAP will be shutdown after maxHeartbeatWriteRetries is reached in case of lost ability to write data in Redis.", - "title": "Max Heartbeat Write Retries", - "examples": [20] - } - }, - "oneOf": [ - { - "properties": { - "host": { - "type": "string", - "description": "The IP or hostname of the server running the Redis service.", - "title": "Host", - "examples": ["127.0.0.1", "localhost", "::1"] - }, - "port": { - "type": "integer", - "title": "Port", - "examples": [6379] - } - }, - "required": ["host", "port"] - }, - { - "properties": { - "sentinels": { - "type": "array", - "title": "Sentinels", - "items": { - "type": "object", - "properties": { - "host": { - "type": "string", - "title": "Host", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "title": "Port", - "examples": [26379] - } - } - }, - "description": "The list of Redis hosts for sentinel configuration." - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the master node in the Redis sentinel group." - } - }, - "required": ["sentinels", "name"] - } - ] - }, - "auditProps": { - "type": "object", - "title": "Audit Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Audit"] - }, - "audit": { - "type": "boolean", - "title": "Audit", - "examples": [true] - }, - "brokerValidation": { - "type": "boolean", - "title": "Broker Validation", - "examples": [true] - } - } - }, - "pathProps": { - "type": "object", - "title": "Path Properties", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "encrypted": { - "type": "boolean", - "description": "A boolean flag indicating Pronghorn core is encrypted.", - "title": "Encrypted", - "examples": [true] - } - } - }, - "alarmProps": { - "title": "Alarm Properties", - "type": "array", - "items": { - "type": "object", - "title": "Remote SNMP Config", - "description": "Remote SNMP destination config.", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "ip": { - "type": "string", - "format": "hostname", - "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", - "title": "Remote Server IP Address", - "examples": ["127.0.0.1"] - }, - "community": { - "type": "string", - "description": "The SNMP community to apply to the outgoing trap or inform.", - "title": "SNMP Community", - "examples": ["public"] - }, - "properties": { - "type": "object", - "properties": { - "retries": { - "type": "integer", - "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", - "title": "Retries", - "examples": [1] - }, - "timeout": { - "type": "integer", - "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", - "title": "Timeout", - "examples": [5000] - }, - "transport": { - "type": "string", - "description": "The protocol to use to send alarms to this receiver.", - "title": "Transport Protocol", - "examples": ["udp4"], - "enum": ["udp4", "udp6"] - }, - "trapPort": { - "type": "integer", - "description": "The remote port of this alarm receiver.", - "title": "SNMP Trap Port", - "examples": [162] - }, - "version": { - "type": "string", - "description": "The SNMP version to use when delivering notifications to this alarm receiver.", - "title": "SNMP Version", - "examples": ["V1"], - "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] - } - } - }, - "type": { - "type": "string", - "description": "The type can be configured as either a trap or inform.", - "title": "SNMP Type", - "examples": ["trap", "inform"], - "enum": ["trap", "inform"] - } - }, - "additionalProperties": false - }, - "minItems": 0 - }, - "id": { - "type": "string", - "title": "Profile ID", - "pattern": "^[^\\/]+$", - "examples": ["profile1"] - }, - "services": { - "type": "array", - "title": "Services", - "items": { - "type": "string", - "examples": ["WorkflowBuilder", "FormBuilder"] - } - }, - "description": { - "type": "string", - "title": "Description", - "examples": ["An IAP Profile"] - }, - "adapterStrategy": { - "type": "object", - "title": "Adapter Strategy", - "properties": { - "device": { - "title": "Device Calls", - "description": "Defines the order in which southbound systems are called.", - "properties": { - "adapterTypes": { - "type": "array", - "uniqueItems": true, - "title": "Adapter Types", - "description": "A list of adapter types that manages the devices.", - "items": { - "type": "string", - "enum": ["NSO", "AutomationGateway"] - } - }, - "exceptions": { - "type": "object", - "maxProperties": 1, - "title": "Exceptions", - "description": "An override for the runCommand's preference to a southbound system.", - "properties": { - "runCommand": { - "type": "string", - "title": "Run Command", - "description": "Runs a command on a device.", - "oneOf": [ - { - "const": "", - "title": "None" - }, - { - "const": "NSO", - "title": "NSO" - }, - { - "const": "AutomationGateway", - "title": "Automation Gateway" - } - ] - } - } - } - }, - "type": "object" - } - }, - "additionalProperties": true - }, - "systemProps": { - "type": "object", - "title": "System Properties", - "description": "Properties used to configure IAP process.", - "properties": { - "shutdownTimeout": { - "type": "integer", - "title": "Shutdown Timeout", - "minimum": 0, - "description": "The amount of time a service should wait before shutting down, in seconds.", - "examples": [3] - }, - "servicesBlacklist": { - "type": "array", - "title": "Services Blacklist", - "description": "An array of services that blocks CRUD operation access for each service listed.", - "items": { - "type": "string", - "description": "The service type that will be denied CRUD operation access.", - "examples": ["Local AAA"] - } - }, - "launchDelay": { - "type": "integer", - "title": "Launch Delay", - "minimum": 0, - "maximum": 60, - "description": "The application/adapter launch delay, in seconds.", - "examples": [5] - }, - "launchTimeout": { - "type": "integer", - "title": "Launch Timeout", - "minimum": 30, - "maximum": 1200, - "description": "The application/adapter launch timeout, in seconds.", - "examples": [60] - }, - "serviceHealthCheckInterval": { - "type": "integer", - "title": "Service Health Check Interval", - "minimum": 1, - "description": "How often to update service health, measured in seconds." - }, - "serviceHealthCheckUnhealthyThreshold": { - "type": "integer", - "title": "Service Health Check Unhealthy Threshold", - "minimum": 1, - "description": "Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline." - }, - "deadProcessCheck": { - "type": "boolean", - "title": "Dead Process Check", - "description": "Enable/disable IAP check for dead applications/adapters.", - "examples": [false, true] - }, - "deadProcessCheckInterval": { - "type": "integer", - "title": "Dead Process Check Interval", - "minimum": 5, - "maximum": 600, - "description": "How often to check if application/adapter stopped sending healthcheck pings, in seconds.", - "examples": [5] - }, - "deadProcessMaxPeriod": { - "type": "integer", - "title": "Dead Process Max Period", - "minimum": 15, - "maximum": 600, - "description": "Maximum time period for application/adapter without sending healthcheck ping, in seconds.", - "examples": [15] - }, - "externalRequestTimeout": { - "type": "integer", - "title": "External Request Timeout", - "minimum": 1, - "maximum": 120, - "description": "The timeout for external API requests, in seconds.", - "examples": [5, 10] - }, - "deviceCountPollingInterval": { - "type": "integer", - "title": "Device Count Polling Interval", - "minimum": 1, - "maximum": 168, - "description": "The interval for how often IAP polls for the number of devices, in hours.", - "examples": [24] - } - } - }, - "prebuiltProps": { - "type": "object", - "title": "Prebuilt Properties", - "properties": { - "repoConfigs": { - "type": "object", - "title": "Repository Configurations", - "description": "The configurations used to fetch Prebuilts from different repositories.", - "properties": { - "@itentialopensource": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "A flag that denotes if the repository configuration is connected", - "enum": [true, false] - }, - "type": { - "type": "string", - "description": "The type of Repository", - "enum": ["gitlab"] - }, - "hostname": { - "type": "string", - "description": "The hostname of the Respository endpoint", - "examples": ["gitlab.com"] - }, - "path": { - "type": "string", - "description": "The path of the Repository endpoint", - "examples": ["itentialopensource/pre-built-automations"] - }, - "credentials": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "An access token used to make HTTP requests", - "examples": ["uTc_P4pnMAEsLbQHmyOt"] - } - }, - "additionalProperties": false - } - } - } - }, - "additionalProperties": true - } - } - }, - "integrationProps": { - "type": "object", - "title": "Integration Properties", - "properties": { - "threadCount": { - "type": "integer", - "title": "Integrations Thread Count", - "minimum": 1, - "maximum": 16, - "description": "The number of threads available for API requests.", - "examples": [5] - }, - "timeout": { - "type": "integer", - "title": "Integrations Timeout", - "description": "The number of milliseconds until an integration request times out.", - "examples": [15000] - } - } - }, - "retryStrategy": { - "type": "object", - "title": "Retry Strategy", - "description": "Properties used to configure the strategy services use on crash.", - "properties": { - "maxRetries": { - "type": "integer", - "title": "Max Retries", - "minimum": 1, - "description": "Specifies the amount of times services will retry on crash before stopping.", - "examples": [5] - }, - "retryResetTimer": { - "type": "integer", - "title": "Retry Reset Timer", - "minimum": 0, - "description": "Specifies the amount of times between each retry before the count will reset in milliseconds.", - "examples": [30000] - } - } - }, - "serviceDirectory": { - "type": "string", - "title": "Service Directory", - "description": "Directory at which to find additional services." - } - }, - "additionalProperties": true - }, - "iap_profiles-schema_snmpConfig": { - "type": "object", - "title": "Remote SNMP Config", - "description": "Remote SNMP destination config.", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "ip": { - "type": "string", - "format": "hostname", - "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", - "title": "Remote Server IP Address", - "examples": ["127.0.0.1"] - }, - "community": { - "type": "string", - "description": "The SNMP community to apply to the outgoing trap or inform.", - "title": "SNMP Community", - "examples": ["public"] - }, - "properties": { - "type": "object", - "properties": { - "retries": { - "type": "integer", - "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", - "title": "Retries", - "examples": [1] - }, - "timeout": { - "type": "integer", - "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", - "title": "Timeout", - "examples": [5000] - }, - "transport": { - "type": "string", - "description": "The protocol to use to send alarms to this receiver.", - "title": "Transport Protocol", - "examples": ["udp4"], - "enum": ["udp4", "udp6"] - }, - "trapPort": { - "type": "integer", - "description": "The remote port of this alarm receiver.", - "title": "SNMP Trap Port", - "examples": [162] - }, - "version": { - "type": "string", - "description": "The SNMP version to use when delivering notifications to this alarm receiver.", - "title": "SNMP Version", - "examples": ["V1"], - "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] - } - } - }, - "type": { - "type": "string", - "description": "The type can be configured as either a trap or inform.", - "title": "SNMP Type", - "examples": ["trap", "inform"], - "enum": ["trap", "inform"] - } - }, - "additionalProperties": false - }, - "iap_profiles-schema_log_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "iap_profiles-schema_sys_log_level": { - "type": "string", - "title": "Sys Log Level", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "iap_profiles-schema_port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - }, - "iap_profiles-schema_uiProps": { - "type": "object", - "title": "UI Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["UI"] - }, - "layout": { - "type": "string", - "title": "Layout", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/layout.jade" - ] - }, - "home": { - "type": "string", - "title": "Home", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/home.jade" - ] - }, - "login": { - "type": "string", - "title": "Login", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/login.jade" - ] - }, - "profile": { - "type": "string", - "title": "Profile", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/views/profile.jade" - ] - }, - "fav_icon": { - "type": "string", - "title": "Favicon", - "examples": [ - "node_modules/@itential/pronghorn-core/ui/img/favicon.ico" - ] - } - } - }, - "iap_profiles-schema_authenticationProps": { - "type": "object", - "title": "Authentication Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Authentication"] - }, - "logoutTime": { - "type": "integer", - "minimum": 2, - "description": "The maximum number of time IAP has to make an api call before the user is logged out, in minutes.", - "title": "Logout Time", - "examples": [20] - }, - "uniqueSession": { - "type": "boolean", - "description": "When uniqueSession is set to true, only one session may be enabled for a given user.", - "title": "Unique Session", - "examples": [false] - }, - "admins": { - "type": "array", - "title": "Admins", - "description": "Members of these groups will be implicitly assigned with admin permissions", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "description": "The name of the AAA adapter in which the groups reside.", - "title": "Provenance", - "examples": ["Local AAA"] - }, - "group": { - "type": "string", - "description": "The name of a user group which will have Pronghorn user management capabilities.", - "title": "Group", - "examples": ["admin"] - } - } - } - }, - "cookieName": { - "type": "string", - "description": "The name used by Pronghorn to identify cookies for user session data", - "title": "Cookie Name", - "examples": ["pronghorn_token"] - }, - "brokerPrincipal": { - "type": "boolean", - "description": "When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal.", - "title": "Broker Principal", - "examples": [false] - } - } - }, - "iap_profiles-schema_expressProps": { - "type": "object", - "title": "Express Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Express Server"] - }, - "cacheControl": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers.", - "title": "Cache Control", - "examples": [false] - }, - "timeout": { - "type": "integer", - "description": "The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client.", - "title": "Timeout", - "examples": [300000] - }, - "access_control_allow_origin": { - "type": "string", - "description": "The configured domain name for the Access-Control-Allow-Origin header used for security.", - "title": "Access-Control-Allow-Origin", - "examples": ["*"] - }, - "express_http": { - "type": "object", - "title": "Express HTTP Settings", - "properties": { - "enable": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests.", - "title": "Enable HTTP", - "examples": [false] - }, - "port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - } - } - }, - "express_https": { - "type": "object", - "title": "Express HTTPS Settings", - "properties": { - "enable": { - "type": "boolean", - "description": "A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests.", - "title": "Enable HTTPS", - "examples": [true] - }, - "port": { - "type": "integer", - "title": "Port", - "minimum": 1, - "maximum": 65535 - }, - "key": { - "type": "string", - "description": "The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property.", - "title": "Key", - "examples": ["/opt/pronghorn/current/keys/key.pem"] - }, - "passphrase": { - "type": "string", - "title": "Passphrase", - "description": "The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase." - }, - "cert": { - "type": "string", - "title": "Certificate", - "description": "The server's public certificate to use for all HTTPS transactions.", - "examples": ["/opt/pronghorn/current/keys/cert.pem"] - }, - "secureProtocol": { - "type": "string", - "description": "The secureProtocol can be used to configure the set of allowed SSL/TLS protocol versions.", - "title": "Secure Protocol", - "examples": ["TLSv1_2_method"], - "enum": ["TLSv1_method", "TLSv1_1_method", "TLSv1_2_method"] - }, - "ciphers": { - "type": "string", - "description": "The set of ciphers to allow when establishing an encrypted session.", - "title": "Ciphers", - "examples": [ - "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" - ] - }, - "client_reneg_limit": { - "type": "integer", - "description": "The maximum number of client renegotiations allowed per renegotiation window.", - "title": "Client Renegotiation Limit", - "examples": [1] - }, - "client_reneg_window": { - "type": "integer", - "description": "The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds.", - "title": "Client Renegotiation Window", - "examples": [600] - } - } - }, - "allowedHttpOptionalVerbs": { - "title": "Allowed HTTP Optional Verbs", - "description": "An array of optional HTTP verbs that are allowed to be used in requests to IAP", - "type": "array", - "uniqueItems": true, - "items": { - "enum": [ - "ACL", - "BIND", - "CHECKOUT", - "CONNECT", - "COPY", - "LINK", - "LOCK", - "MERGE", - "MKACTIVITY", - "MKCALENDAR", - "MKCOL", - "MOVE", - "M-SEARCH", - "NOTIFY", - "PROPFIND", - "PROPPATCH", - "PURGE", - "REBIND", - "REPORT", - "SEARCH", - "SUBSCRIBE", - "TRACE", - "UNBIND", - "UNLINK", - "UNLOCK", - "UNSUBSCRIBE" - ] - } - } - } - }, - "iap_profiles-schema_loggerProps": { - "type": "object", - "title": "Logger Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Logging"] - }, - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store Pronghorn log files.", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name of the current Pronghorn log file.", - "title": "Filename", - "examples": ["pronghorn.log"] - }, - "log_max_file_size": { - "type": "integer", - "title": "Max File Size", - "description": "The maximum size of each Pronghorn log file in bytes.", - "examples": [1048576] - }, - "log_max_files": { - "type": "integer", - "description": "The maximum number of log files maintained on the server.", - "title": "Max Number of Files", - "examples": [100] - }, - "log_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "console_level": { - "type": "string", - "title": "Log Level", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "webserver": { - "type": "object", - "description": "Determines how to set up the web server access log.", - "title": "Webserver", - "properties": { - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store web server access log files.", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name for the web server access log file.", - "title": "Filename", - "examples": ["webserver.log"] - } - } - }, - "syslog": { - "type": "object", - "description": "Allows Pronghorn to send log messages to a local or remote syslog daemon.", - "title": "Syslog", - "properties": { - "level": { - "type": "string", - "title": "Sys Log Level", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "host": { - "type": "string", - "description": "The host running syslogd.", - "title": "Host", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "description": "The port on the host that syslog is running on.", - "title": "Port", - "minimum": 1, - "maximum": 65535, - "examples": [514] - }, - "protocol": { - "type": "string", - "title": "Protocol", - "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", - "examples": ["udp4"], - "enum": ["tcp4", "udp4", "unix", "unix-connect"] - }, - "facility": { - "type": "string", - "description": "The syslog facility to use.", - "title": "Facility", - "examples": ["local0"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", - "examples": ["5424"], - "enum": ["BSD", "5424"] - }, - "path": { - "type": "string", - "title": "Path", - "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured.", - "format": "uri-reference", - "examples": ["/dev/log"] - }, - "pid": { - "type": "string", - "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", - "title": "Process ID", - "examples": ["process.pid"] - }, - "localhost": { - "type": "string", - "description": "The host to indicate that log messages are coming from.", - "title": "Log Host", - "examples": ["localhost"] - }, - "app_name": { - "type": "string", - "description": "The name of the application.", - "title": "Application Name", - "examples": ["process.title"] - }, - "eol": { - "type": "string", - "title": "End of Line Character", - "description": "The end of line character to be added to the end of the message.", - "examples": ["CR"] - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "iap_profiles-schema_redisProps": { - "type": "object", - "title": "Redis Properties", - "properties": { - "db": { - "type": "integer", - "description": "The Redis database number to connect to (may be any of 0-15).", - "title": "Database Number", - "examples": [0], - "minimum": 0 - }, - "username": { - "type": "string", - "title": "Username", - "description": "The username with access to the Redis DB.", - "examples": ["admin"] - }, - "password": { - "type": "string", - "title": "Password", - "description": "The passphrase protecting access to the Redis DB.", - "examples": ["$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e"] - }, - "maxRetriesPerRequest": { - "type": "integer", - "description": "IAP will be shutdown after maxRetriesPerRequest is reached in case of lost Redis network connection.", - "title": "Max Retries Per Request", - "examples": [20] - }, - "maxHeartbeatWriteRetries": { - "type": "integer", - "description": "IAP will be shutdown after maxHeartbeatWriteRetries is reached in case of lost ability to write data in Redis.", - "title": "Max Heartbeat Write Retries", - "examples": [20] - } - }, - "oneOf": [ - { - "properties": { - "host": { - "type": "string", - "description": "The IP or hostname of the server running the Redis service.", - "title": "Host", - "examples": ["127.0.0.1", "localhost", "::1"] - }, - "port": { - "type": "integer", - "title": "Port", - "examples": [6379] - } - }, - "required": ["host", "port"] - }, - { - "properties": { - "sentinels": { - "type": "array", - "title": "Sentinels", - "items": { - "type": "object", - "properties": { - "host": { - "type": "string", - "title": "Host", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "title": "Port", - "examples": [26379] - } - } - }, - "description": "The list of Redis hosts for sentinel configuration." - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the master node in the Redis sentinel group." - } - }, - "required": ["sentinels", "name"] - } - ] - }, - "iap_profiles-schema_auditProps": { - "type": "object", - "title": "Audit Properties", - "properties": { - "description": { - "type": "string", - "title": "Description", - "examples": ["Audit"] - }, - "audit": { - "type": "boolean", - "title": "Audit", - "examples": [true] - }, - "brokerValidation": { - "type": "boolean", - "title": "Broker Validation", - "examples": [true] - } - } - }, - "iap_profiles-schema_pathProps": { - "type": "object", - "title": "Path Properties", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "encrypted": { - "type": "boolean", - "description": "A boolean flag indicating Pronghorn core is encrypted.", - "title": "Encrypted", - "examples": [true] - } - } - }, - "iap_profiles-schema_alarmProps": { - "title": "Alarm Properties", - "type": "array", - "items": { - "type": "object", - "title": "Remote SNMP Config", - "description": "Remote SNMP destination config.", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "ip": { - "type": "string", - "format": "hostname", - "description": "The IP address of the remote alarm receiver. FQDNs are also supported in this field.", - "title": "Remote Server IP Address", - "examples": ["127.0.0.1"] - }, - "community": { - "type": "string", - "description": "The SNMP community to apply to the outgoing trap or inform.", - "title": "SNMP Community", - "examples": ["public"] - }, - "properties": { - "type": "object", - "properties": { - "retries": { - "type": "integer", - "description": "The number of timeout cycles to wait for an acknowledgement when delivering inform type notifications.", - "title": "Retries", - "examples": [1] - }, - "timeout": { - "type": "integer", - "description": "The number of seconds to wait for an acknowledgement when delivering inform type notifications.", - "title": "Timeout", - "examples": [5000] - }, - "transport": { - "type": "string", - "description": "The protocol to use to send alarms to this receiver.", - "title": "Transport Protocol", - "examples": ["udp4"], - "enum": ["udp4", "udp6"] - }, - "trapPort": { - "type": "integer", - "description": "The remote port of this alarm receiver.", - "title": "SNMP Trap Port", - "examples": [162] - }, - "version": { - "type": "string", - "description": "The SNMP version to use when delivering notifications to this alarm receiver.", - "title": "SNMP Version", - "examples": ["V1"], - "enum": ["V1", "V2", "V2C", "v1", "v2", "v2c"] - } - } - }, - "type": { - "type": "string", - "description": "The type can be configured as either a trap or inform.", - "title": "SNMP Type", - "examples": ["trap", "inform"], - "enum": ["trap", "inform"] - } - }, - "additionalProperties": false - }, - "minItems": 0 - }, - "iap_profiles-schema_id": { - "type": "string", - "title": "Profile ID", - "pattern": "^[^\\/]+$", - "examples": ["profile1"] - }, - "iap_profiles-schema_services": { - "type": "array", - "title": "Services", - "items": { - "type": "string", - "examples": ["WorkflowBuilder", "FormBuilder"] - } - }, - "iap_profiles-schema_description": { - "type": "string", - "title": "Description", - "examples": ["An IAP Profile"] - }, - "iap_profiles-schema_adapterStrategy": { - "type": "object", - "title": "Adapter Strategy", - "properties": { - "device": { - "title": "Device Calls", - "description": "Defines the order in which southbound systems are called.", - "properties": { - "adapterTypes": { - "type": "array", - "uniqueItems": true, - "title": "Adapter Types", - "description": "A list of adapter types that manages the devices.", - "items": { - "type": "string", - "enum": ["NSO", "AutomationGateway"] - } - }, - "exceptions": { - "type": "object", - "maxProperties": 1, - "title": "Exceptions", - "description": "An override for the runCommand's preference to a southbound system.", - "properties": { - "runCommand": { - "type": "string", - "title": "Run Command", - "description": "Runs a command on a device.", - "oneOf": [ - { - "const": "", - "title": "None" - }, - { - "const": "NSO", - "title": "NSO" - }, - { - "const": "AutomationGateway", - "title": "Automation Gateway" - } - ] - } - } - } - }, - "type": "object" - } - }, - "additionalProperties": true - }, - "iap_profiles-schema_systemProps": { - "type": "object", - "title": "System Properties", - "description": "Properties used to configure IAP process.", - "properties": { - "shutdownTimeout": { - "type": "integer", - "title": "Shutdown Timeout", - "minimum": 0, - "description": "The amount of time a service should wait before shutting down, in seconds.", - "examples": [3] - }, - "servicesBlacklist": { - "type": "array", - "title": "Services Blacklist", - "description": "An array of services that blocks CRUD operation access for each service listed.", - "items": { - "type": "string", - "description": "The service type that will be denied CRUD operation access.", - "examples": ["Local AAA"] - } - }, - "launchDelay": { - "type": "integer", - "title": "Launch Delay", - "minimum": 0, - "maximum": 60, - "description": "The application/adapter launch delay, in seconds.", - "examples": [5] - }, - "launchTimeout": { - "type": "integer", - "title": "Launch Timeout", - "minimum": 30, - "maximum": 1200, - "description": "The application/adapter launch timeout, in seconds.", - "examples": [60] - }, - "serviceHealthCheckInterval": { - "type": "integer", - "title": "Service Health Check Interval", - "minimum": 1, - "description": "How often to update service health, measured in seconds." - }, - "serviceHealthCheckUnhealthyThreshold": { - "type": "integer", - "title": "Service Health Check Unhealthy Threshold", - "minimum": 1, - "description": "Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline." - }, - "deadProcessCheck": { - "type": "boolean", - "title": "Dead Process Check", - "description": "Enable/disable IAP check for dead applications/adapters.", - "examples": [false, true] - }, - "deadProcessCheckInterval": { - "type": "integer", - "title": "Dead Process Check Interval", - "minimum": 5, - "maximum": 600, - "description": "How often to check if application/adapter stopped sending healthcheck pings, in seconds.", - "examples": [5] - }, - "deadProcessMaxPeriod": { - "type": "integer", - "title": "Dead Process Max Period", - "minimum": 15, - "maximum": 600, - "description": "Maximum time period for application/adapter without sending healthcheck ping, in seconds.", - "examples": [15] - }, - "externalRequestTimeout": { - "type": "integer", - "title": "External Request Timeout", - "minimum": 1, - "maximum": 120, - "description": "The timeout for external API requests, in seconds.", - "examples": [5, 10] - }, - "deviceCountPollingInterval": { - "type": "integer", - "title": "Device Count Polling Interval", - "minimum": 1, - "maximum": 168, - "description": "The interval for how often IAP polls for the number of devices, in hours.", - "examples": [24] - } - } - }, - "iap_profiles-schema_integrationProps": { - "type": "object", - "title": "Integration Properties", - "properties": { - "threadCount": { - "type": "integer", - "title": "Integrations Thread Count", - "minimum": 1, - "maximum": 16, - "description": "The number of threads available for API requests.", - "examples": [5] - }, - "timeout": { - "type": "integer", - "title": "Integrations Timeout", - "description": "The number of milliseconds until an integration request times out.", - "examples": [15000] - } - } - }, - "iap_profiles-schema_retryStrategy": { - "type": "object", - "title": "Retry Strategy", - "description": "Properties used to configure the strategy services use on crash.", - "properties": { - "maxRetries": { - "type": "integer", - "title": "Max Retries", - "minimum": 1, - "description": "Specifies the amount of times services will retry on crash before stopping.", - "examples": [5] - }, - "retryResetTimer": { - "type": "integer", - "title": "Retry Reset Timer", - "minimum": 0, - "description": "Specifies the amount of times between each retry before the count will reset in milliseconds.", - "examples": [30000] - } - } - }, - "iap_profiles-schema_serviceDirectory": { - "type": "string", - "title": "Service Directory", - "description": "Directory at which to find additional services." - }, - "iap_services-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Services Schema", - "description": "All of the properties required for a service.", - "properties": { - "loggerProps": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description property", - "title": "Description", - "default": "Logger Settings", - "examples": ["Logging"] - }, - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store Pronghorn log files.", - "default": "/var/log/pronghorn", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name of the current Pronghorn log file.", - "title": "Filename", - "default": "pronghorn.log", - "examples": ["pronghorn.log"] - }, - "log_max_file_size": { - "type": "integer", - "title": "Max File Size", - "description": "The maximum size of each Pronghorn log file in bytes.", - "default": 1048576, - "examples": [1048576] - }, - "log_max_files": { - "type": "integer", - "description": "The maximum number of log files maintained on the server.", - "title": "Max Number of Files", - "default": 100, - "examples": [100] - }, - "log_timezone_offset": { - "type": "integer", - "description": "An integer specifying the offset from GMT/UTC time that will be used when writing to the log files.", - "title": "Timezone Offset", - "default": 0, - "examples": [-5], - "minimum": -12, - "maximum": 12 - }, - "log_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "console_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "metrics_filename": { - "type": "string", - "description": "The name of the job metrics log file, if applicable.", - "title": "Metrics Filename", - "default": "metrics.log", - "examples": ["metrics.log"] - }, - "metrics_max_files": { - "type": "integer", - "description": "The maximum number of job metrics log files maintained on the server, if applicable.", - "title": "Max Number of Metrics Files", - "default": 31, - "examples": [31] - }, - "metrics_rotation_interval": { - "type": "string", - "description": "The time until the metrics log is rotated in minutes, hours, days, or weeks, if applicable.", - "title": "Rotation Interval of Metrics Files", - "default": "7d", - "examples": ["7d"] - }, - "metrics_rotation_size": { - "type": "string", - "description": "The maximum file size before the metrics log is rotated in kilobytes, megabytes, or gigabytes, if applicable.", - "title": "Rotation Size of Metrics Files", - "default": "10M", - "examples": ["10M"] - }, - "syslog": { - "type": "object", - "description": "The syslog properties allow Pronghorn to send log messages to a local or remote syslog daemon.", - "properties": { - "level": { - "type": "string", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "host": { - "type": "string", - "description": "The host running syslogd.", - "title": "Host", - "default": "localhost", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "description": "The port on the host that syslog is running on.", - "title": "Port", - "default": 514, - "minimum": 1, - "maximum": 65535, - "examples": [514] - }, - "protocol": { - "type": "string", - "title": "Protocol", - "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", - "default": "udp4", - "examples": ["udp4"], - "enum": ["tcp4", "udp4", "unix", "unix-connect"] - }, - "facility": { - "type": "string", - "description": "Syslog facility to use.", - "title": "Facility", - "default": "local0", - "examples": ["local0"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", - "default": "BSD", - "examples": ["5424"], - "enum": ["BSD", "5424"] - }, - "path": { - "type": "string", - "title": "Path", - "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X).If path is used, host, port and protocol do not need to be configured.", - "default": "", - "format": "uri-reference", - "examples": ["/dev/log"] - }, - "pid": { - "type": "string", - "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", - "title": "Process Id", - "default": "process.pid", - "examples": ["process.pid"] - }, - "localhost": { - "type": "string", - "description": "Host to indicate that log messages are coming from.", - "title": "Log Host", - "default": "", - "examples": ["localhost"] - }, - "app_name": { - "type": "string", - "description": "The name of the application.", - "title": "Application Name", - "default": "", - "examples": ["process.title"] - }, - "eol": { - "type": "string", - "title": "End of Line Character", - "description": "The end of line character to be added to the end of the message.", - "default": "", - "examples": ["CR"] - } - }, - "allOf": [ - { - "required": ["level", "facility", "type"] - }, - { - "anyOf": [ - { - "required": ["host", "port", "protocol"] - }, - { - "required": ["path"] - } - ] - } - ], - "additionalProperties": false - } - }, - "required": [ - "log_max_files", - "log_max_file_size", - "log_level", - "log_directory", - "log_filename", - "console_level" - ], - "additionalProperties": false - }, - "isEncrypted": { - "type": "boolean", - "title": "isEncrypted", - "default": false, - "description": "Whether or not this service is encrypted", - "examples": [true, false] - }, - "profiling": { - "type": "boolean", - "title": "profiling", - "default": false, - "description": "Whether or not to profile this service", - "examples": [true, false] - }, - "model": { - "type": "string", - "title": "Model", - "default": "", - "description": "The model used by the service", - "examples": ["@itential/adapter-local_aaa"], - "pattern": "^@[-_.a-z]+/.+" - }, - "name": { - "type": "string", - "title": "Name", - "default": "", - "description": "The name of the service", - "pattern": "^[^\\/]+$", - "examples": ["Local AAA"] - }, - "type": { - "type": "string", - "title": "Type", - "default": "Application", - "description": "If the service is an app or adapter", - "enum": ["Application", "Adapter"] - }, - "properties": { - "type": "object", - "title": "Properties", - "description": "The properties of a service", - "properties": {} - }, - "virtual": { - "type": "boolean", - "title": "virtual", - "default": false, - "description": "Whether or not this service is an Integration.", - "examples": [true, false] - }, - "systemProps": { - "type": "object", - "title": "System Properties", - "description": "Properties used to configure IAP process.", - "properties": { - "maxOldSpaceSize": { - "type": "number", - "title": "maxOldSpaceSize", - "description": "Sets the limit heap memory size on service child process.", - "minimum": 100, - "examples": [2048, 1024] - } - } - }, - "eventDeduplication": { - "type": "object", - "title": "eventDeduplication", - "description": "Properties used by the event-system to deduplicate events", - "required": ["active", "cacheTtl", "uniqueProps"], - "properties": { - "active": { - "type": "boolean", - "description": "Whether or not event deduplication is configured", - "title": "Active" - }, - "cacheTtl": { - "type": "integer", - "description": "The time to live set up for event deduplication", - "title": "Cache Ttl", - "examples": [10000] - }, - "uniqueProps": { - "type": "array", - "description": "Unique properties set up in event deduplication", - "title": "Unique Props", - "items": { - "type": "string", - "examples": ["/messageId"] - } - } - } - } - }, - "oneOf": [ - { - "properties": { - "type": { - "const": "Application" - }, - "properties": { - "properties": {} - } - } - }, - { - "properties": { - "type": { - "const": "Adapter" - }, - "properties": { - "properties": { - "id": { - "type": "string", - "title": "id", - "default": "", - "description": "The id for the service", - "const": { - "$data": "2/name" - }, - "examples": ["Local AAA"] - }, - "type": { - "type": "string", - "title": "Type", - "default": "", - "description": "The type of service", - "examples": ["local_aaa"] - }, - "properties": { - "type": "object", - "properties": {} - }, - "brokers": { - "type": "array", - "uniqueItems": true, - "description": "Brokers which utilize this service", - "items": { - "type": "string", - "description": "Name of the broker", - "enum": [ - "aaa", - "compliance", - "device", - "fault", - "instance", - "inventory", - "method", - "notification", - "performance", - "persistence", - "service", - "topology" - ], - "examples": ["aaa"] - } - }, - "groups": { - "type": "array", - "description": "Groups which can use this service", - "items": { - "type": "string", - "description": "The mongo id of the group", - "examples": ["5fe9f10cc1fca243d562e1d8"], - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["id", "type", "properties", "brokers", "groups"] - } - } - } - ], - "required": [ - "loggerProps", - "isEncrypted", - "model", - "name", - "type", - "properties" - ], - "additionalProperties": false - }, - "iap_services-schema_log_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "iap_services-schema_sys_log_level": { - "type": "string", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "iap_services-schema_name": { - "type": "string", - "title": "Name", - "default": "", - "description": "The name of the service", - "pattern": "^[^\\/]+$", - "examples": ["Local AAA"] - }, - "iap_services-schema_model": { - "type": "string", - "title": "Model", - "default": "", - "description": "The model used by the service", - "examples": ["@itential/adapter-local_aaa"], - "pattern": "^@[-_.a-z]+/.+" - }, - "iap_services-schema_isEncrypted": { - "type": "boolean", - "title": "isEncrypted", - "default": false, - "description": "Whether or not this service is encrypted", - "examples": [true, false] - }, - "iap_services-schema_type": { - "type": "string", - "title": "Type", - "default": "Application", - "description": "If the service is an app or adapter", - "enum": ["Application", "Adapter"] - }, - "iap_services-schema_loggerProps": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description property", - "title": "Description", - "default": "Logger Settings", - "examples": ["Logging"] - }, - "log_directory": { - "type": "string", - "title": "Directory", - "description": "The directory to store Pronghorn log files.", - "default": "/var/log/pronghorn", - "examples": ["/var/log/pronghorn"] - }, - "log_filename": { - "type": "string", - "description": "The name of the current Pronghorn log file.", - "title": "Filename", - "default": "pronghorn.log", - "examples": ["pronghorn.log"] - }, - "log_max_file_size": { - "type": "integer", - "title": "Max File Size", - "description": "The maximum size of each Pronghorn log file in bytes.", - "default": 1048576, - "examples": [1048576] - }, - "log_max_files": { - "type": "integer", - "description": "The maximum number of log files maintained on the server.", - "title": "Max Number of Files", - "default": 100, - "examples": [100] - }, - "log_timezone_offset": { - "type": "integer", - "description": "An integer specifying the offset from GMT/UTC time that will be used when writing to the log files.", - "title": "Timezone Offset", - "default": 0, - "examples": [-5], - "minimum": -12, - "maximum": 12 - }, - "log_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "console_level": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "metrics_filename": { - "type": "string", - "description": "The name of the job metrics log file, if applicable.", - "title": "Metrics Filename", - "default": "metrics.log", - "examples": ["metrics.log"] - }, - "metrics_max_files": { - "type": "integer", - "description": "The maximum number of job metrics log files maintained on the server, if applicable.", - "title": "Max Number of Metrics Files", - "default": 31, - "examples": [31] - }, - "metrics_rotation_interval": { - "type": "string", - "description": "The time until the metrics log is rotated in minutes, hours, days, or weeks, if applicable.", - "title": "Rotation Interval of Metrics Files", - "default": "7d", - "examples": ["7d"] - }, - "metrics_rotation_size": { - "type": "string", - "description": "The maximum file size before the metrics log is rotated in kilobytes, megabytes, or gigabytes, if applicable.", - "title": "Rotation Size of Metrics Files", - "default": "10M", - "examples": ["10M"] - }, - "syslog": { - "type": "object", - "description": "The syslog properties allow Pronghorn to send log messages to a local or remote syslog daemon.", - "properties": { - "level": { - "type": "string", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - }, - "host": { - "type": "string", - "description": "The host running syslogd.", - "title": "Host", - "default": "localhost", - "examples": ["localhost"] - }, - "port": { - "type": "integer", - "description": "The port on the host that syslog is running on.", - "title": "Port", - "default": 514, - "minimum": 1, - "maximum": 65535, - "examples": [514] - }, - "protocol": { - "type": "string", - "title": "Protocol", - "description": "The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.", - "default": "udp4", - "examples": ["udp4"], - "enum": ["tcp4", "udp4", "unix", "unix-connect"] - }, - "facility": { - "type": "string", - "description": "Syslog facility to use.", - "title": "Facility", - "default": "local0", - "examples": ["local0"] - }, - "type": { - "type": "string", - "title": "Type", - "description": "The type of syslog protocol to use. Possible values are BSD and 5424.", - "default": "BSD", - "examples": ["5424"], - "enum": ["BSD", "5424"] - }, - "path": { - "type": "string", - "title": "Path", - "description": "The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X).If path is used, host, port and protocol do not need to be configured.", - "default": "", - "format": "uri-reference", - "examples": ["/dev/log"] - }, - "pid": { - "type": "string", - "description": "Process identifier (PID) of the process that log messages are coming from (Default is process.pid).", - "title": "Process Id", - "default": "process.pid", - "examples": ["process.pid"] - }, - "localhost": { - "type": "string", - "description": "Host to indicate that log messages are coming from.", - "title": "Log Host", - "default": "", - "examples": ["localhost"] - }, - "app_name": { - "type": "string", - "description": "The name of the application.", - "title": "Application Name", - "default": "", - "examples": ["process.title"] - }, - "eol": { - "type": "string", - "title": "End of Line Character", - "description": "The end of line character to be added to the end of the message.", - "default": "", - "examples": ["CR"] - } - }, - "allOf": [ - { - "required": ["level", "facility", "type"] - }, - { - "anyOf": [ - { - "required": ["host", "port", "protocol"] - }, - { - "required": ["path"] - } - ] - } - ], - "additionalProperties": false - } - }, - "required": [ - "log_max_files", - "log_max_file_size", - "log_level", - "log_directory", - "log_filename", - "console_level" - ], - "additionalProperties": false - }, - "iap_services-schema_properties": { - "type": "object", - "title": "Properties", - "description": "The properties of a service", - "properties": {} - }, - "iap_services-schema_virtual": { - "type": "boolean", - "title": "virtual", - "default": false, - "description": "Whether or not this service is an Integration.", - "examples": [true, false] - }, - "iap_banner-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "The root schema", - "description": "The root schema comprises the entire JSON document.", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "active": { - "type": "boolean", - "description": "A flag indicating if the banner will be displayed to users" - }, - "text": { - "type": "string", - "description": "Text in the banner when displayed" - }, - "backgroundColor": { - "type": "string", - "description": "The background color for the banner displayed", - "examples": ["#fff"] - }, - "dismissible": { - "type": "boolean", - "description": "A flag indicating if a banner should be dismissible by users" - }, - "startTime": { - "type": "string", - "description": "An ISO Timestring value indicating when the banner will show", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "endTime": { - "type": "string", - "description": "A, ISO Timestring value indicating when the banner will no longer show", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "allPages": { - "type": "boolean", - "description": "A flag indicating if the banner should show on all pages or only the IAP home page" - }, - "image": { - "description": "A base64 image string containing the image that will be shown on the banner", - "type": "string" - }, - "messageLastUpdated": { - "type": "string", - "description": "An ISO Timestring value indicating when the banner message was last updated", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", - "examples": ["2018-08-02T15:56:12.912Z"] - } - }, - "required": ["text", "active", "startTime", "dismissible", "allPages"] - }, - "iap_authorization-common": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Common Authorization Schema" - }, - "iap_authorization-common_accounts-query": { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["john_doe"] - }, - "firstname": { - "type": "string", - "examples": ["John"] - }, - "email": { - "type": "string", - "examples": ["user@email.com"] - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - } - } - }, - "iap_authorization-common_groups-query": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["group1"] - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "description": { - "type": "string", - "examples": ["this is group1"] - } - } - }, - "iap_authorization-common_roles-query": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "examples": ["Custom"] - }, - "name": { - "type": "string", - "examples": ["role_1"] - }, - "description": { - "type": "string", - "examples": ["description of role_1"] - } - } - }, - "iap_authorization-common_roleId": { - "title": "roleId", - "type": "string", - "examples": ["Authorization.admin"] - }, - "iap_groups-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Group Schema", - "description": "This is the schema for an IAP group stored in Mongo", - "properties": { - "provenance": { - "title": "Provenance", - "description": "AAA provider where group originated", - "type": "string", - "examples": ["Local AAA", "Pronghorn"] - }, - "name": { - "title": "Name", - "description": "Name of group", - "type": "string", - "examples": ["group_1"] - }, - "description": { - "title": "Description", - "description": "Description of group", - "type": "string", - "examples": ["description of group_1"] - }, - "memberOf": { - "title": "Assigned Groups", - "description": "Parent groups which this group is a part of", - "type": "array", - "items": { - "type": "object", - "properties": { - "aaaManaged": { - "description": "Whether group comes from an external AAA or not", - "type": "boolean" - }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "assignedRoles": { - "title": "Assigned Roles", - "description": "Roles assigned to this group", - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - }, - "additionalProperties": false - } - }, - "inactive": { - "title": "Inactive", - "description": "Setting for whether group is active or not", - "type": "boolean" - }, - "_meta": { - "title": "Metadata", - "description": "Metadata for group", - "type": "object", - "properties": { - "created": { - "title": "Created", - "description": "When the group was created", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updated": { - "title": "Updated", - "description": "When the group was last updated", - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - } - } - } - }, - "additionalProperties": false, - "required": [ - "provenance", - "name", - "description", - "memberOf", - "assignedRoles", - "inactive" - ] - }, - "iap_groups-schema_inactive": { - "title": "Inactive", - "description": "Setting for whether group is active or not", - "type": "boolean" - }, - "iap_groups-schema_provenance": { - "title": "Provenance", - "description": "AAA provider where group originated", - "type": "string", - "examples": ["Local AAA", "Pronghorn"] - }, - "iap_groups-schema_name": { - "title": "Name", - "description": "Name of group", - "type": "string", - "examples": ["group_1"] - }, - "iap_groups-schema_description": { - "title": "Description", - "description": "Description of group", - "type": "string", - "examples": ["description of group_1"] - }, - "iap_groups-schema_memberOf": { - "title": "Assigned Groups", - "description": "Parent groups which this group is a part of", - "type": "array", - "items": { - "type": "object", - "properties": { - "aaaManaged": { - "description": "Whether group comes from an external AAA or not", - "type": "boolean" - }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "iap_groups-schema_assignedRoles": { - "title": "Assigned Roles", - "description": "Roles assigned to this group", - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - }, - "additionalProperties": false - } - }, - "iap_roles-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Role Schema", - "description": "This is the schema for an IAP role stored in Mongo", - "properties": { - "provenance": { - "type": "string", - "examples": ["Custom"] - }, - "name": { - "type": "string", - "examples": ["role_1"] - }, - "description": { - "type": "string", - "examples": ["description of role_1"] - }, - "allowedMethods": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["methodName"] - }, - "provenance": { - "type": "string", - "examples": ["ApplicationName"] - } - } - } - }, - "allowedViews": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/manual/task/path"] - }, - "provenance": { - "type": "string", - "examples": ["ApplicationName"] - } - } - } - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updated": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - } - } - } - }, - "additionalProperties": false, - "required": [ - "provenance", - "name", - "description", - "allowedMethods", - "allowedViews" - ] - }, - "iap_roles-schema_name": { - "type": "string", - "examples": ["role_1"] - }, - "iap_roles-schema_description": { - "type": "string", - "examples": ["description of role_1"] - }, - "iap_roles-schema_allowedMethods": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["methodName"] - }, - "provenance": { - "type": "string", - "examples": ["ApplicationName"] - } - } - } - }, - "iap_roles-schema_allowedViews": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/manual/task/path"] - }, - "provenance": { - "type": "string", - "examples": ["ApplicationName"] - } - } - } - }, - "iap_system-common": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Common System Schema" - }, - "iap_system-common_methods-query": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["getAdapters"] - }, - "provenance": { - "type": "string", - "examples": ["Adapters"] - }, - "deprecated": { - "type": "boolean" - } - } - }, - "iap_system-common_views-query": { - "type": "object", - "properties": { - "path": { - "type": "string", - "examples": ["/"] - }, - "provenance": { - "type": "string", - "examples": ["WorkFlowEngine"] - } - } - }, - "iap_device-count-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Device Count History Schema", - "description": "This is the schema for an IAP device count stored in Mongo", - "properties": { - "timestamp": { - "type": "string", - "description": "An ISODate representing when the device count was taken", - "examples": ["2023-02-14T20:06:50.569Z"] - }, - "serverId": { - "type": "string", - "description": "The serverId where the device count was taken" - }, - "counts": { - "type": "object", - "description": "The key/value pair between an adapter name and the number of devices", - "additionalProperties": { - "type": "integer", - "minimum": 0 - } - } - }, - "required": ["timestamp", "serverId", "counts"], - "additionalProperties": false - }, - "iap_services-health-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "The root schema", - "description": "The root schema comprises the entire JSON document.", - "properties": { - "id": { - "type": "string", - "examples": ["AdminEssentials"] - }, - "package_id": { - "type": "string", - "title": "Model", - "default": "", - "description": "The model used by the service", - "examples": ["@itential/adapter-local_aaa"], - "pattern": "^@[-_.a-z]+/.+" - }, - "version": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - }, - "type": { - "type": "string", - "enum": ["Adapter", "Application"] - }, - "description": { - "type": "string", - "examples": ["A basic description"] - }, - "state": { - "type": "string", - "enum": ["DEAD", "STOPPED", "RUNNING", "DELETED"] - }, - "connection": { - "type": "object", - "oneOf": [ - { - "const": null - }, - { - "properties": { - "state": { - "type": "string", - "examples": ["ONLINE"] - } - } - } - ] - }, - "uptime": { - "type": "number", - "description": "Number of seconds the current process has been running.", - "examples": [2245.9722] - }, - "memoryUsage": { - "type": "object", - "properties": { - "rss": { - "type": "integer", - "description": "Resident Set Size - the amount of space occupied in the main memory - in bytes", - "examples": [7125982] - }, - "heapTotal": { - "type": "integer", - "description": "Heap Total in bytes for the Node V8 engine", - "examples": [7125982] - }, - "heapUsed": { - "type": "integer", - "description": "Heap Used in bytes by the Node V8 engine", - "examples": [7125982] - }, - "external": { - "type": "integer", - "description": "External usage - memory usage of C++ objects bound to JavaScript objects managed by the Node V8 engine - in bytes", - "examples": [7125982] - } - } - }, - "cpuUsage": { - "type": "object", - "description": "Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)", - "properties": { - "user": { - "description": "Microseconds spent in user mode", - "type": "integer", - "examples": [7125982] - }, - "system": { - "description": "Microseconds spent in system mode", - "type": "integer", - "examples": [7125982] - } - } - }, - "pid": { - "type": "integer", - "examples": [7125982] - }, - "logger": { - "type": "object", - "properties": { - "console": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "file": { - "type": "string", - "examples": ["error", "warn", "info", "debug", "trace", "spam"], - "enum": ["error", "warn", "info", "debug", "trace", "spam"] - }, - "syslog": { - "type": "string", - "examples": ["debug", "info", "warning", "error"], - "enum": ["debug", "info", "warning", "error"] - } - } - }, - "routePrefix": { - "type": "string", - "examples": ["admin", "search"] - }, - "prevUptime": { - "type": "number", - "examples": [2245.9722] - } - } - }, - "iap_services-health-schema_version": { - "type": "string", - "examples": ["0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0"] - }, - "iap_services-health-schema_cpuUsage": { - "type": "object", - "description": "Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)", - "properties": { - "user": { - "description": "Microseconds spent in user mode", - "type": "integer", - "examples": [7125982] - }, - "system": { - "description": "Microseconds spent in system mode", - "type": "integer", - "examples": [7125982] - } - } - }, - "iap_services-health-schema_uptime": { - "type": "number", - "description": "Number of seconds the current process has been running.", - "examples": [2245.9722] - }, - "iap_services-health-schema_pid": { - "type": "integer", - "examples": [7125982] - }, - "iap_services-health-schema_memoryUsage": { - "type": "object", - "properties": { - "rss": { - "type": "integer", - "description": "Resident Set Size - the amount of space occupied in the main memory - in bytes", - "examples": [7125982] - }, - "heapTotal": { - "type": "integer", - "description": "Heap Total in bytes for the Node V8 engine", - "examples": [7125982] - }, - "heapUsed": { - "type": "integer", - "description": "Heap Used in bytes by the Node V8 engine", - "examples": [7125982] - }, - "external": { - "type": "integer", - "description": "External usage - memory usage of C++ objects bound to JavaScript objects managed by the Node V8 engine - in bytes", - "examples": [7125982] - } - } - }, - "iap_links-query": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential External Link Query Schema", - "description": "This is the schema for queries on IAP external links", - "properties": { - "name": { - "type": "string", - "examples": ["Google"] - }, - "address": { - "type": "string", - "examples": ["https://www.google.com/"] - }, - "description": { - "type": "string", - "examples": ["A link to Google"] - } - }, - "additionalProperties": false - }, - "iap_links-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential External Link Schema", - "description": "This is the schema for an IAP external link stored in Mongo", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "pattern": "^(?![\\s.]+$)[a-zA-Z\\s.]*$", - "examples": ["Google"] - }, - "address": { - "type": "string", - "minLength": 1, - "examples": ["https://www.google.com/"] - }, - "description": { - "type": "string", - "examples": ["A link to Google"] - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updated": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - } - } - } - }, - "required": ["name", "address"], - "additionalProperties": false - }, - "iap_links-schema_name": { - "type": "string", - "minLength": 1, - "pattern": "^(?![\\s.]+$)[a-zA-Z\\s.]*$", - "examples": ["Google"] - }, - "iap_links-schema_address": { - "type": "string", - "minLength": 1, - "examples": ["https://www.google.com/"] - }, - "iap_links-schema_description": { - "type": "string", - "examples": ["A link to Google"] - }, - "iap_repository-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Prebuilt Repository Configuration Schema", - "description": "This is the schema for a Repository Configuration used to fetch Prebuilts", - "properties": { - "enabled": {}, - "type": {}, - "hostname": {}, - "path": {}, - "credentials": {}, - "versionStatus": { - "type": "string", - "description": "The version status of the Pre-built Automation in relation to the current IAP version", - "enum": ["current", "latest"], - "default": "latest" - } - }, - "required": ["enabled", "type", "hostname", "path", "credentials"], - "additionalProperties": false - }, - "iap_repository-schema_enabled": { - "type": "boolean", - "description": "A flag that denotes if the repository configuration is connected", - "enum": [true, false] - }, - "iap_repository-schema_type": { - "type": "string", - "description": "The type of Repository", - "enum": ["gitlab"] - }, - "iap_repository-schema_hostname": { - "type": "string", - "description": "The hostname of the Respository endpoint", - "examples": ["gitlab.com"] - }, - "iap_repository-schema_path": { - "type": "string", - "description": "The path of the Repository endpoint", - "examples": ["itentialopensource/pre-built-automations"] - }, - "iap_repository-schema_credentials": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "An access token used to make HTTP requests", - "examples": ["uTc_P4pnMAEsLbQHmyOt"] - } - }, - "additionalProperties": false - }, - "iap_sso-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "SSO Schema", - "description": "Schema describing an SSO configuration object", - "properties": { - "name": { - "type": "string", - "description": "Name of the SSO configuration", - "examples": ["Auth0", "Okta"] - }, - "ssoType": { - "type": "string", - "description": "Single sign on type, SAML, OpenID, etc.", - "examples": ["saml"], - "enum": ["saml"] - }, - "settings": { - "type": "object", - "description": "The configuration for the sso type used", - "oneOf": [ - { - "type": "object", - "required": [ - "issuer", - "loginURL", - "certificate", - "samlUserNameAttribute", - "samlGroupsAttribute", - "forceLogin" - ], - "additionalProperties": false, - "properties": { - "description": { - "type": "string", - "description": "A description of the sso configuration", - "examples": ["This sso configuration connects to Okta"] - }, - "issuer": { - "type": "string", - "description": "Issuer identity provider", - "examples": ["https://www.auth0.com/oauth2/example"] - }, - "loginURL": { - "type": "string", - "description": "Login URL for SSO identity provider", - "examples": ["https://www.auth0.com/login"] - }, - "logoutURL": { - "type": "string", - "description": "Logout URL for SSO identity provider", - "examples": ["https://www.auth0.com/logout"] - }, - "certificate": { - "type": "string", - "description": "Security certificate", - "examples": [ - "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==" - ] - }, - "samlEmailAttribute": { - "type": "string", - "description": "Attribute containing user email address", - "examples": [ - "mail", - "email", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - ], - "default": "email" - }, - "samlUserNameAttribute": { - "type": "string", - "description": "Attribute containing the full user name", - "examples": [ - "userName", - "user", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" - ], - "default": "username" - }, - "samlGroupsAttribute": { - "type": "string", - "description": "Attribute containing the name of the groups property", - "examples": [ - "groups", - "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups" - ], - "default": "groups" - }, - "samlFirstNameAttribute": { - "type": "string", - "description": "Attribute containing the first name of the user", - "examples": [ - "firstName", - "name", - "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" - ] - }, - "forceLogin": { - "type": "boolean", - "description": "A boolean flag indicating if a user is forced to login", - "title": "Force User Login", - "default": false - } - } - } - ] - }, - "active": { - "description": "Whether or not the SSO Config is selected for use. For 'active' to be true, 'tested' must also be true.", - "type": "boolean", - "default": false - }, - "tested": { - "type": "boolean", - "description": "Whether the sso config was tested" - } - }, - "required": ["name", "ssoType", "settings"], - "additionalProperties": false - }, - "iap_sso-schema_samlConfig": { - "type": "object", - "required": [ - "issuer", - "loginURL", - "certificate", - "samlUserNameAttribute", - "samlGroupsAttribute", - "forceLogin" - ], - "additionalProperties": false, - "properties": { - "description": { - "type": "string", - "description": "A description of the sso configuration", - "examples": ["This sso configuration connects to Okta"] - }, - "issuer": { - "type": "string", - "description": "Issuer identity provider", - "examples": ["https://www.auth0.com/oauth2/example"] - }, - "loginURL": { - "type": "string", - "description": "Login URL for SSO identity provider", - "examples": ["https://www.auth0.com/login"] - }, - "logoutURL": { - "type": "string", - "description": "Logout URL for SSO identity provider", - "examples": ["https://www.auth0.com/logout"] - }, - "certificate": { - "type": "string", - "description": "Security certificate", - "examples": [ - "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==" - ] - }, - "samlEmailAttribute": { - "type": "string", - "description": "Attribute containing user email address", - "examples": [ - "mail", - "email", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - ], - "default": "email" - }, - "samlUserNameAttribute": { - "type": "string", - "description": "Attribute containing the full user name", - "examples": [ - "userName", - "user", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" - ], - "default": "username" - }, - "samlGroupsAttribute": { - "type": "string", - "description": "Attribute containing the name of the groups property", - "examples": [ - "groups", - "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups" - ], - "default": "groups" - }, - "samlFirstNameAttribute": { - "type": "string", - "description": "Attribute containing the first name of the user", - "examples": [ - "firstName", - "name", - "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" - ] - }, - "forceLogin": { - "type": "boolean", - "description": "A boolean flag indicating if a user is forced to login", - "title": "Force User Login", - "default": false - } - } - }, - "iap_mapping-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential Group Mapping Schema", - "description": "This is the schema for an IAP group mapping stored in Mongo", - "properties": { - "externalGroup": { - "type": "string", - "description": "name of the external group" - }, - "provenance": { - "type": "string", - "description": "The AAA provider for the external group", - "examples": ["Okta"] - }, - "iapGroups": { - "type": "array", - "items": { - "type": "string", - "description": "ObjectId for the group within IAP" - } - } - }, - "required": ["externalGroup", "iapGroups", "provenance"], - "additionalProperties": false - }, - "iap_mapping-schema_iapGroups": { - "type": "array", - "items": { - "type": "string", - "description": "ObjectId for the group within IAP" - } - }, - "iap_mapping-schema_externalGroup": { - "type": "string", - "description": "name of the external group" - }, - "iap_mapping-schema_provenance": { - "type": "string", - "description": "The AAA provider for the external group", - "examples": ["Okta"] - }, - "iap_git-common": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Common Git Schema" - }, - "iap_git-common_type": { - "type": "string", - "description": "The type of Git provider being used", - "enum": ["GitHub", "GitLab"] - }, - "iap_git-common_repoPath": { - "title": "repoPath", - "description": "The path in Git to the repository", - "type": "string", - "examples": ["github-organization", "gitlabGroup%2FsubGroup"] - }, - "iap_git-common_branchName": { - "title": "branchName", - "description": "The name of the branch inside a Git repository", - "type": "string", - "examples": ["main"] - }, - "iap_git-common_projectPath": { - "title": "repoPath", - "description": "The file path within a Git repository to a project file", - "type": "string", - "examples": ["directory%2Fproject.json", "example.json"] - }, - "iap_git-common_commitMessage": { - "title": "commitMessage", - "description": "The commit message sent to Git when updating a project", - "type": "string", - "examples": ["This is an example commit message."] - }, - "iap_service-accounts-schema": { - "$schema": "http://json-schema.org/draft-07/schema", - "type": "object", - "title": "Itential OAuth Service Account Schema", - "description": "This is the schema for an OAuth service account stored in Mongo", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "name": { - "type": "string", - "description": "The name associated with the service account", - "examples": ["ExampleName"] - }, - "description": { - "type": "string", - "description": "The description of the service account", - "examples": [ - "This is a service account for the external Example system" - ] - }, - "clientId": {}, - "clientSecret": { - "type": "string", - "description": "Uuid representation of client secret", - "examples": ["d4c673d6-17f8-4e76-8034-a87820f96618"] - }, - "_meta": { - "type": "object", - "properties": { - "updated": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "updatedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "created": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - } - } - } - }, - "additionalProperties": false, - "required": ["name", "description", "clientId", "clientSecret"] - }, - "iap_service-accounts-schema_name": { - "type": "string", - "description": "The name associated with the service account", - "examples": ["ExampleName"] - }, - "iap_service-accounts-schema_description": { - "type": "string", - "description": "The description of the service account", - "examples": [ - "This is a service account for the external Example system" - ] - }, - "iap_service-accounts-schema_clientId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "iap_service-accounts-schema_clientSecret": { - "type": "string", - "description": "Uuid representation of client secret", - "examples": ["d4c673d6-17f8-4e76-8034-a87820f96618"] - }, - "iap_service-accounts-schema_modifiedByDereferenced": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "String representation of a MongoDB ObjectId", - "examples": ["5cb7b531d06cceb89fd21b1c"] - }, - "username": { - "type": "string", - "examples": ["username@itential"] - } - } - }, - "iap_service-accounts-schema_timestamp": { - "type": "string", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "formbuilder_formDocument": { - "title": "form document", - "description": "A form document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - "name": { - "type": "string", - "examples": ["Form 123"] - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time" - }, - "created_by": {}, - "last_updated": { - "type": "string", - "format": "date-time" - }, - "last_updated_by": {}, - "elements": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["service_model"] - }, - "id": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["/ncs:services/test_devices:service_name"] - } - }, - "required": ["name"] - } - }, - "required": ["type", "id"] - }, - "examples": [ - [ - { - "type": "method", - "id": { - "name": "method_name_1" - } - } - ] - ] - }, - "children": { - "type": "array", - "items": { - "type": "object", - "required": ["properties", "id", "type"], - "properties": { - "id": { - "type": "string", - "oneOf": [ - { - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - { - "pattern": "cont-." - } - ] - }, - "element": { - "type": "string", - "examples": [ - "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}" - ] - }, - "type": { - "type": "string", - "examples": ["container"] - }, - "name": { - "type": "string", - "examples": ["vlan_id_123"] - }, - "display_name": { - "type": "string", - "examples": ["vlan"] - }, - "source_type": { - "type": "string", - "enum": ["service_model", "custom", "method"] - }, - "source": { - "type": "string", - "examples": ["/ncs:services/abc_devices:ios.device"] - }, - "key": { - "type": "string", - "examples": [ - "service.vlanid", - "key_545385c3-fc66-491b-bf6f-abc2214366dc" - ] - }, - "properties": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["leafref"] - }, - "path": { - "type": "string", - "examples": ["/ncs:devices/ncs:device/ncs:name"] - }, - "min": { - "anyOf": [ - { - "type": "string", - "examples": ["1"] - }, - { - "type": "integer", - "examples": [1] - }, - { - "type": "null" - } - ] - }, - "max": { - "anyOf": [ - { - "type": "string", - "examples": ["4"] - }, - { - "type": "integer", - "examples": [1] - }, - { - "type": "null" - } - ] - }, - "minLength": { - "anyOf": [ - { - "type": "string", - "examples": ["1"] - }, - { - "type": "integer", - "examples": [1] - }, - { - "type": "null" - } - ] - }, - "maxLength": { - "anyOf": [ - { - "type": "string", - "examples": ["4"] - }, - { - "type": "integer", - "examples": [1] - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "null" - } - ] - }, - "direction": { - "type": "string", - "examples": ["vertical"] - }, - "required": { - "type": "boolean" - }, - "enforce": { - "type": "boolean" - }, - "hidden": { - "type": "boolean" - } - } - } - }, - "examples": [ - { - "type": "field", - "name": "ipaddress", - "properties": { - "type": "string", - "prefix": "" - }, - "description": "IP address", - "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}", - "source_type": "method", - "source": "method_name_1", - "id": "a40044c2-f378-4b2b-a81a-41d78979e583", - "yangkey": "", - "key": "method_name_1.ipAddress" - } - ] - } - } - }, - "required": ["name", "children", "elements"] - }, - "formbuilder_formDocument_formName": { - "type": "string", - "examples": ["Form 123"] - }, - "formbuilder_formDocument_ObjectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formbuilder_formDocument_uuidv4": { - "type": "string", - "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - }, - "formbuilder_formDocument_groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "formbuilder_formDocument_elements": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["service_model"] - }, - "id": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["/ncs:services/test_devices:service_name"] - } - }, - "required": ["name"] - } - }, - "required": ["type", "id"] - }, - "examples": [ - [ - { - "type": "method", - "id": { - "name": "method_name_1" - } - } - ] - ] - }, - "search_searchResults": { - "title": "search results", - "description": "The results of a search", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "label": { - "type": "string", - "examples": [ - "Forms", - "The Title of the Application the result came from." - ] - }, - "type": { - "type": "string", - "examples": [ - "forms", - "The name of the Collection the result came from" - ] - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": [ - "912fd926-5391-48ff-b265-394d00640f4f", - "The id of the result." - ] - }, - "name": { - "type": "string", - "examples": ["testForm", "Name of the result."] - }, - "description": { - "type": "string", - "examples": [ - "Hi I describe the result", - "Description for the result is optional." - ] - }, - "url": { - "type": "string", - "examples": [ - "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f", - "The shortened url to access the result from." - ] - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": [ - "5c8fa4a8d8e04500b1b2f28f", - "The id of the tag." - ] - }, - "description": { - "type": "string", - "examples": [ - "Hi I describe the tag", - "Description for the tag is optional." - ] - }, - "name": { - "type": "string", - "examples": ["testTag", "Name of the tag."] - } - } - } - } - } - } - }, - "count": { - "type": "integer" - } - } - } - } - } - }, - "configuration_manager_common_mongoObjectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "configuration_manager_common_timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "configuration_manager_common_standardName": { - "type": "string", - "examples": ["my standard name"], - "minLength": 1 - }, - "configuration_manager_common_standardDescription": { - "type": "string", - "examples": ["my standard description"], - "minLength": 1 - }, - "configuration_manager_common_multiElementString": { - "type": "string", - "examples": ["device1, device2, device3, device4"], - "minLength": 1 - }, - "configuration_manager_deviceData_deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "configuration_manager_deviceData_deviceDetails": { - "title": "deviceDetails", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["xr9kv01-aws"] - }, - "authgroup": { - "type": "string", - "examples": ["xr9kv-aws"] - }, - "ipaddress": { - "type": "string", - "examples": ["10.1.6.100"] - }, - "address": { - "type": "string", - "examples": ["10.1.6.100"] - }, - "port": { - "type": "string", - "examples": ["22"] - }, - "device-type": { - "type": "string", - "examples": ["cli"] - }, - "ostype": { - "type": "string", - "examples": ["cisco-ios-xr"] - }, - "ned": { - "type": "string", - "examples": ["cisco-ios-xr"] - }, - "admin": { - "type": "boolean" - }, - "host": { - "type": "string", - "examples": ["nso46"] - }, - "actions": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "addDevice", - "addDeviceGroup", - "addDeviceToGroup", - "addToAuthGroup", - "applyTemplate", - "applyTemplates", - "applyVariableTemplate", - "checkSync", - "checkSyncDevices", - "isAlive", - "deleteDevice", - "deleteDeviceGroup", - "dryRunVariableTemplate", - "getAuthGroups", - "getConfig", - "getDevice", - "getDeviceGroups", - "getDeviceGroupsForDevices", - "getDevices", - "getDevicesFiltered", - "getNEDs", - "getOutOfSyncConfig", - "getTemplates", - "liveStatus", - "passThru", - "pingDevice", - "removeDeviceFromGroup", - "restoreDevice", - "runAction", - "runCommand", - "setConfig", - "syncFrom", - "syncFromDevices", - "syncTo", - "syncToDevices", - "turnUpDevice", - "verifyConfig" - ] - }, - "uniqueItems": true - }, - "origins": { - "type": "array", - "items": { - "type": "string", - "examples": ["nso46"] - } - } - }, - "required": [ - "name", - "device-type", - "ipaddress", - "port", - "ostype", - "host", - "actions", - "origin" - ] - }, - "configuration_manager_deviceData_deviceConfigurationFormat": { - "title": "format", - "type": "string", - "enum": ["native", "xml", "json"], - "examples": ["native"] - }, - "configuration_manager_deviceData_deviceConfiguration": { - "title": "config", - "type": "object", - "properties": { - "device": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "config": { - "type": "string", - "examples": ["hostname ios0\nno service password-encryption\n..."] - } - } - }, - "configuration_manager_deviceData_deviceConfigurationString": { - "type": "string", - "examples": ["hostname ios0\nno service password-encryption\n..."] - }, - "configuration_manager_deviceData_backupDescription": { - "type": "string", - "examples": ["description of backup"] - }, - "configuration_manager_deviceData_backupNotes": { - "type": "string", - "examples": ["notes about backup"] - }, - "configuration_manager_deviceData_backup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "provider": { - "type": "string" - }, - "type": { - "title": "format", - "type": "string", - "enum": ["native", "xml", "json"], - "examples": ["native"] - }, - "date": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "rawConfig": { - "type": "string", - "examples": ["hostname ios0\nno service password-encryption\n..."] - }, - "description": { - "type": "string", - "examples": ["description of backup"] - }, - "notes": { - "type": "string", - "examples": ["notes about backup"] - }, - "gbac": { - "type": "object", - "description": "Sets of group Ids that are allowd to access this automation.", - "properties": { - "write": { - "type": "array", - "description": "Group ids that have write access to the automation document.", - "items": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - }, - "read": { - "type": "array", - "description": "Group ids that have read access to the automation document.", - "items": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - }, - "required": ["write", "read"] - } - } - }, - "configuration_manager_deviceGroupDocument": { - "$schema": "http://json-schema.org/draft-07/schema#", - "description": "A group of devices that are referenced by name only", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string", - "examples": ["my standard name"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["my standard description"], - "minLength": 1 - }, - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - } - }, - "additionalProperties": true - }, - "configuration_manager_deviceGroupDocument_groupDetails": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["my standard name"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["my standard description"], - "minLength": 1 - }, - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - } - }, - "required": ["name"], - "additionalProperties": false - }, - "configuration_manager_deviceGroupDocument_updateGroupDetails": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["my standard name"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["my standard description"], - "minLength": 1 - }, - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - } - }, - "additionalProperties": false - }, - "configuration_manager_deviceGroupDocument_createGroupResponseWithName": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string" - }, - "message": { - "type": "string" - }, - "status": { - "type": "string" - } - }, - "required": ["id", "name", "message", "status"] - }, - "configuration_manager_deviceGroupDocument_updateGroupsResponse": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "modified": { - "type": "number" - } - }, - "required": ["status", "modified"] - }, - "configuration_manager_deviceGroupDocument_deleteGroupResponse": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "deleted": { - "type": "number" - } - }, - "required": ["status", "deleted"] - }, - "configuration_manager_goldenConfigData_goldenConfigNodePath": { - "title": "goldenConfigNodePath", - "type": "string", - "examples": ["base", "base/US East", "base/US East/Atlanta"] - }, - "configuration_manager_goldenConfigData_goldenConfigTreeVersionName": { - "title": "goldenConfigTreeVersionName", - "type": "string", - "examples": ["initial", "v2", "v3", "draft-v4"] - }, - "configuration_manager_goldenConfigData_goldenConfigNode": { - "title": "goldenConfigNode", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["base", "us-east", "edge"] - }, - "attributes": { - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "children": { - "type": "array", - "items": { - "title": "goldenConfigNode", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["base", "us-east", "edge"] - }, - "attributes": { - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "children": { - "type": "array", - "items": {} - } - }, - "required": ["name", "attributes", "children"] - } - } - }, - "required": ["name", "attributes", "children"] - }, - "configuration_manager_goldenConfigData_goldenConfigTreeVersion": { - "title": "goldenConfigTreeVersion", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string", - "examples": [ - "Cisco Edge - Day 0", - "Cisco Edge - Day 1", - "Cisco Core - Day 0", - "Cisco Core - Day 1" - ] - }, - "deviceType": { - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "version": { - "type": "string", - "examples": ["initial", "v2", "v3", "draft v4"] - }, - "root": { - "title": "goldenConfigNode", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["base", "us-east", "edge"] - }, - "attributes": { - "type": "object", - "properties": { - "devices": { - "type": "array", - "items": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - } - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "children": { - "type": "array", - "items": {} - } - }, - "required": ["name", "attributes", "children"] - }, - "variables": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["variable name"] - }, - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["variable value"] - } - } - } - }, - "created": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "lastUpdated": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "lastUpdatedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigTreeVersionSummary": { - "title": "goldenConfigTreeVersion", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "name": { - "type": "string", - "examples": [ - "Cisco Edge - Day 0", - "Cisco Edge - Day 1", - "Cisco Core - Day 0", - "Cisco Core - Day 1" - ] - }, - "deviceType": { - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "versions": { - "type": "array", - "items": { - "type": "string", - "examples": ["initial", "v2", "v3", "draft v4"] - } - }, - "created": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "lastUpdated": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigSpecWord": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigSpecLineId": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "configuration_manager_goldenConfigData_goldenConfigSpecLine": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": ["required", "disallowed", "ignored", "optional"] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": ["required", "disallowed", "ignored", "optional"] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": {} - } - } - } - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigSpec": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "deviceType": { - "type": "string", - "examples": [ - "cisco-ios", - "cisco-ios-xr", - "cisco-nx", - "a10-acos", - "f5-big-ip" - ] - }, - "lines": { - "type": "array", - "items": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": ["required", "disallowed", "ignored", "optional"] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": {} - } - } - } - }, - "created": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "lastUpdated": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "lastUpdatedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigJSONSpec": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "deviceType": { - "type": "string", - "examples": ["json"] - }, - "data": { - "type": "object", - "properties": {} - }, - "created": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "lastUpdated": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "lastUpdatedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - } - }, - "configuration_manager_goldenConfigData_goldenConfigVariables": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["variable name"] - }, - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["variable value"] - } - } - } - }, - { - "type": "object", - "properties": {}, - "additionalProperties": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["string value", "^regular.*expression$"] - } - } - }, - { - "type": "string", - "examples": ["string value"] - } - ] - } - } - ] - }, - "configuration_manager_goldenConfigData_reportGradingOptions": { - "type": "object", - "properties": { - "weights": { - "type": "object", - "properties": { - "error": { - "type": "number" - }, - "warning": { - "type": "number" - }, - "info": { - "type": "number" - } - } - }, - "benchmarks": { - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "number" - } - } - } - }, - "configuration_manager_goldenConfigData_gradeDeviceComplianceHistoryOptions": { - "type": "object", - "properties": { - "weights": { - "type": "object", - "properties": { - "error": { - "type": "number" - }, - "warning": { - "type": "number" - }, - "info": { - "type": "number" - } - } - }, - "benchmarks": { - "type": "object", - "properties": {}, - "additionalProperties": { - "type": "number" - } - }, - "limit": { - "type": "integer", - "minimum": 1 - } - } - }, - "configuration_manager_goldenConfigData_complianceSummary": { - "title": "complianceSummary", - "type": "object", - "properties": { - "errors": { - "type": "integer", - "minimum": 0 - }, - "warnings": { - "type": "integer", - "minimum": 0 - }, - "passes": { - "type": "integer", - "minimum": 0 - }, - "infos": { - "type": "integer", - "minimum": 0 - }, - "deviceWithErrors": { - "type": "integer", - "minimum": 0 - }, - "deviceWithWarnings": { - "type": "integer", - "minimum": 0 - }, - "deviceWithInfos": { - "type": "integer", - "minimum": 0 - }, - "fullyCompliantDevices": { - "type": "integer", - "minimum": 0 - }, - "numDevices": { - "type": "integer", - "minimum": 0 - } - } - }, - "configuration_manager_goldenConfigData_complianceReport": { - "title": "complianceReport", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "batchId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "treeId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "version": { - "title": "goldenConfigTreeVersionName", - "type": "string", - "examples": ["initial", "v2", "v3", "draft-v4"] - }, - "nodePath": { - "title": "goldenConfigNodePath", - "type": "string", - "examples": ["base", "base/US East", "base/US East/Atlanta"] - }, - "deviceType": { - "type": "string", - "examples": ["cisco-ios", "cisco-ios-xr", "junos"] - }, - "specId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "inheritedSpecIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - }, - "deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "variables": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["variable name"] - }, - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["variable value"] - } - } - } - }, - "timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "totals": { - "type": "object", - "properties": { - "errors": { - "type": "integer", - "minimum": 0 - }, - "warnings": { - "type": "integer", - "minimum": 0 - }, - "infos": { - "type": "integer", - "minimum": 0 - }, - "passes": { - "type": "integer", - "minimum": 0 - } - } - }, - "issues": { - "type": "array", - "items": { - "title": "complianceIssue", - "type": "object", - "properties": { - "severity": { - "enum": ["error", "warning", "info"] - }, - "type": { - "enum": ["required", "disallowed"] - }, - "message": { - "type": "string", - "examples": ["Required config not found"] - }, - "specLineId": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "path": { - "type": "array", - "items": { - "type": "string", - "examples": ["interface GigE1"] - } - }, - "spec": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": ["required", "disallowed", "ignored", "optional"] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": {} - } - } - }, - "configWords": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "literal" - }, - "value": { - "type": "string", - "examples": ["word"] - } - } - } - }, - "candidates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "literal" - }, - "value": { - "type": "string", - "examples": ["word"] - } - } - } - } - } - } - }, - "score": { - "type": "number" - } - } - }, - "configuration_manager_goldenConfigData_complianceReportBrief": { - "title": "complianceReportBrief", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "batchId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "treeId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "version": { - "type": "string", - "examples": ["initial", "v2", "v3", "draft v4"] - }, - "nodePath": { - "title": "goldenConfigNodePath", - "type": "string", - "examples": ["base", "base/US East", "base/US East/Atlanta"] - }, - "deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "totals": { - "type": "object", - "properties": { - "errors": { - "type": "integer", - "minimum": 0 - }, - "warnings": { - "type": "integer", - "minimum": 0 - }, - "infos": { - "type": "integer", - "minimum": 0 - }, - "passes": { - "type": "integer", - "minimum": 0 - } - } - } - } - }, - "configuration_manager_goldenConfigData_complianceReportBriefGraded": { - "title": "complianceReportBriefGraded", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "nodePath": { - "type": "string", - "examples": ["base/US East/Atlanta"] - }, - "deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "error": { - "type": "integer", - "minimum": 0 - }, - "warning": { - "type": "integer", - "minimum": 0 - }, - "info": { - "type": "integer", - "minimum": 0 - }, - "pass": { - "type": "integer", - "minimum": 0 - }, - "score": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "grade": { - "type": "string", - "examples": ["pass", "review", "fail"] - } - } - }, - "configuration_manager_goldenConfigData_complianceReportGraded": { - "title": "complianceReportGraded", - "allOf": [ - { - "title": "complianceReport", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "batchId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "treeId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "version": { - "title": "goldenConfigTreeVersionName", - "type": "string", - "examples": ["initial", "v2", "v3", "draft-v4"] - }, - "nodePath": { - "title": "goldenConfigNodePath", - "type": "string", - "examples": ["base", "base/US East", "base/US East/Atlanta"] - }, - "deviceType": { - "type": "string", - "examples": ["cisco-ios", "cisco-ios-xr", "junos"] - }, - "specId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - }, - "inheritedSpecIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "examples": ["5c35355dbebaa82eaf8113f0"] - } - }, - "deviceName": { - "type": "string", - "title": "name", - "examples": ["xr9kv-atl"] - }, - "variables": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["variable name"] - }, - "type": { - "type": "string", - "enum": ["literal", "regex"] - }, - "value": { - "type": "string", - "examples": ["variable value"] - } - } - } - }, - "timestamp": { - "type": "string", - "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z", - "examples": ["2019-04-12T14:42:47.958Z"] - }, - "totals": { - "type": "object", - "properties": { - "errors": { - "type": "integer", - "minimum": 0 - }, - "warnings": { - "type": "integer", - "minimum": 0 - }, - "infos": { - "type": "integer", - "minimum": 0 - }, - "passes": { - "type": "integer", - "minimum": 0 - } - } - }, - "issues": { - "type": "array", - "items": { - "title": "complianceIssue", - "type": "object", - "properties": { - "severity": { - "enum": ["error", "warning", "info"] - }, - "type": { - "enum": ["required", "disallowed"] - }, - "message": { - "type": "string", - "examples": ["Required config not found"] - }, - "specLineId": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "path": { - "type": "array", - "items": { - "type": "string", - "examples": ["interface GigE1"] - } - }, - "spec": { - "title": "goldenConfigSpecLine", - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{16}$", - "examples": [ - "5c353f69d085d85c", - "5c353f69e69c9dc4", - "5c353f691dd5c3b9", - "5c9964aa0d66293a", - "5c353f694ed8385d", - "5c353f699915cc4a", - "5c353f692edfafcf", - "5c353f6940fd1ec5", - "5c353f6932963635" - ] - }, - "evalMode": { - "type": "string", - "enum": [ - "required", - "disallowed", - "ignored", - "optional" - ] - }, - "severity": { - "type": "string", - "enum": ["error", "warning", "info"] - }, - "words": { - "type": "array", - "items": { - "title": "goldenConfigSpecWord", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["literal", "regex", "variable"] - }, - "value": { - "type": "string", - "examples": [ - " or or " - ] - } - } - } - }, - "lines": { - "type": "array", - "items": {} - } - } - }, - "configWords": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "literal" - }, - "value": { - "type": "string", - "examples": ["word"] - } - } - } - }, - "candidates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "literal" - }, - "value": { - "type": "string", - "examples": ["word"] - } - } - } - } - } - } - }, - "score": { - "type": "number" - } - } - }, - { - "type": "object", - "properties": { - "score": { - "type": "number" - }, - "grade": { - "type": "string", - "examples": ["pass", "fail", "review"] - } - } - } - ] - }, - "automation-studio_automation": { - "title": "workflow document", - "description": "Third generation workflow document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "namespace": { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - }, - "name": { - "type": "string", - "examples": [ - "Port Turn Up IOS", - "Push Config to Device", - "Command Template Runner" - ] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "string", - "examples": ["Port Turn Up IOS", "Push Config to Device"] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "integer", - "title": "Pre automation time of automation", - "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", - "examples": [5000, 250000] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "workflow_end": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "sla": { - "type": "integer", - "title": "Task SLA", - "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", - "examples": ["3600000"] - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": {}, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": {}, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "canvasVersion": { - "type": "number", - "const": 3 - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - } - }, - "additionalProperties": false, - "required": [ - "name", - "type", - "tasks", - "transitions", - "groups", - "canvasVersion" - ] - }, - "automation-studio_automationUpdate": { - "title": "workflow document", - "description": "Third generation workflow document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "namespace": { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - }, - "name": { - "type": "string", - "examples": [ - "Port Turn Up IOS", - "Push Config to Device", - "Command Template Runner" - ] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "string", - "examples": ["Port Turn Up IOS", "Push Config to Device"] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "integer", - "title": "Pre automation time of automation", - "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", - "examples": [5000, 250000] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "workflow_end": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "sla": { - "type": "integer", - "title": "Task SLA", - "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", - "examples": ["3600000"] - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": {}, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": {}, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "canvasVersion": { - "type": "number", - "const": 3 - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - } - }, - "additionalProperties": false, - "required": [ - "name", - "type", - "tasks", - "transitions", - "groups", - "canvasVersion" - ] - }, - "automation-studio_componentGroup": { - "title": "Component Group Document", - "description": "An entity representing a component group.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the component group" - }, - "name": { - "type": "string", - "examples": ["Infoblox Workflows"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["Infoblox Workflows"] - }, - "gbacRead": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "CAcFAfEa9aCe7ba08d482B3F", - "F880C8dEBAf70BfB85ec7eCc", - "5AC59E1De2Ce2203cFeb3E22" - ] - } - }, - "gbacWrite": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "CAcFAfEa9aCe7ba08d482B3F", - "F880C8dEBAf70BfB85ec7eCc", - "5AC59E1De2Ce2203cFeb3E22" - ] - } - }, - "members": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "properties": { - "path": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - } - }, - "type": { - "enum": ["folder"] - } - } - }, - { - "properties": { - "path": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - }, - "type": { - "enum": ["component"] - }, - "sourceCollection": { - "type": "string", - "examples": ["workflows", "json-forms", "transformations"] - }, - "ref": { - "type": "string", - "examples": ["7192B8CcD680858dA81EADCa"] - } - } - } - ] - } - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "meta": { - "type": "object" - } - }, - "required": ["name", "gbacRead", "members"], - "additionalProperties": false - }, - "automation-studio_componentGroupImport": { - "title": "Component Group Import Data", - "description": "Data to import as a new component group document.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the component group" - }, - "name": { - "type": "string", - "examples": ["Assign Next IP - Infoblox", "Get Next IP - Infoblox"], - "minLength": 1 - }, - "gbacRead": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "CAcFAfEa9aCe7ba08d482B3F", - "F880C8dEBAf70BfB85ec7eCc", - "5AC59E1De2Ce2203cFeb3E22" - ] - } - }, - "members": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "properties": { - "path": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - } - }, - "type": { - "enum": ["folder"] - } - } - }, - { - "properties": { - "path": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - }, - "type": { - "enum": ["component"] - }, - "sourceCollection": { - "type": "string", - "examples": ["workflows", "json-forms", "transformations"] - }, - "ref": { - "type": "string", - "examples": ["7192B8CcD680858dA81EADCa"] - } - } - } - ] - } - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "meta": { - "type": "object" - } - }, - "required": ["name", "gbacRead", "members"], - "additionalProperties": false - }, - "automation-studio_componentGroupUpdate": { - "title": "Component Group Update", - "description": "An entity representing an update to an existing template document.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the component group" - }, - "name": { - "type": "string", - "examples": ["Assign Next IP - Infoblox", "Get Next IP - Infoblox"], - "minLength": 1 - }, - "gbacRead": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "CAcFAfEa9aCe7ba08d482B3F", - "F880C8dEBAf70BfB85ec7eCc", - "5AC59E1De2Ce2203cFeb3E22" - ] - } - }, - "members": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "properties": { - "path": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - } - }, - "type": { - "enum": ["folder"] - } - } - }, - { - "properties": { - "path": { - "type": "string", - "examples": [ - "Assign Next IP - Infoblox", - "Get Next IP - Infoblox" - ] - }, - "type": { - "enum": ["component"] - }, - "sourceCollection": { - "type": "string", - "examples": ["workflows", "json-forms", "transformations"] - }, - "ref": { - "type": "string", - "examples": ["7192B8CcD680858dA81EADCa"] - } - } - } - ] - } - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "meta": { - "type": "object" - } - }, - "required": ["name", "gbacRead", "members"], - "additionalProperties": false - }, - "automation-studio_project-thumbnails-update-data": { - "title": "Project Thumbnail Update Values", - "description": "Project Thumbnail Update Values", - "type": "object", - "required": ["imageData"], - "properties": { - "imageData": { - "description": "Binary image data encoded as a base64 string", - "type": "string" - }, - "backgroundColor": { - "description": "Thumbnail background color", - "type": "string", - "default": "#FFFFFF" - } - } - }, - "automation-studio_projects-common_components": { - "title": "Project components", - "description": "A list of member components in the project", - "type": "array", - "items": { - "title": "Project component", - "description": "An IAP component which resides within a project", - "type": "object", - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string", - "examples": [ - "1Ac4B2268489019745B5baa4", - "2D772A00dd2Ccedf3bd313bd", - "866a9B98DdD58Ff0e14ebB16" - ] - }, - "folder": { - "title": "Project component folder", - "description": "", - "type": "string", - "pattern": "^/" - } - } - } - }, - "automation-studio_projects-create-data": { - "title": "Project Create Data", - "description": "POST body properties required to create a project", - "type": "object", - "additionalProperties": true, - "required": ["name"], - "properties": { - "name": { - "description": "Project name", - "type": "string", - "examples": [ - "Firewall Service Provisioning", - "Arista EOS Utilities", - "Github" - ] - }, - "description": { - "title": "Project description", - "description": "A free-form block of text for describing project intent and function", - "type": "string", - "examples": [ - "This project is used at Acme Corp as the foundation of some major parts of our business process.", - "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" - ] - }, - "components": { - "title": "Project components", - "description": "A list of member components in the project", - "type": "array", - "items": { - "title": "Project component", - "description": "An IAP component which resides within a project", - "type": "object", - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string", - "examples": [ - "1Ac4B2268489019745B5baa4", - "2D772A00dd2Ccedf3bd313bd", - "866a9B98DdD58Ff0e14ebB16" - ] - }, - "folder": { - "title": "Project component folder", - "description": "", - "type": "string", - "pattern": "^/" - } - } - } - } - } - }, - "automation-studio_projects-export-v1": { - "title": "Project Export Document", - "description": "An exported project document", - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "iid", - "name", - "description", - "thumbnail", - "backgroundColor", - "components", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "name": { - "description": "Project name", - "type": "string", - "examples": [ - "Firewall Service Provisioning", - "Arista EOS Utilities", - "Github" - ] - }, - "description": { - "title": "Project description", - "description": "A free-form block of text for describing project intent and function", - "type": "string", - "examples": [ - "This project is used at Acme Corp as the foundation of some major parts of our business process.", - "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" - ] - }, - "thumbnail": { - "description": "Base64 string encoding binary image data for project thumbnail", - "type": "string" - }, - "backgroundColor": { - "description": "Thumbnail background color", - "type": "string", - "default": "#FFFFFF" - }, - "components": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": ["iid", "type", "reference", "folder", "document"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string", - "examples": [ - "1Ac4B2268489019745B5baa4", - "2D772A00dd2Ccedf3bd313bd", - "866a9B98DdD58Ff0e14ebB16" - ] - }, - "folder": { - "title": "Project component folder", - "description": "", - "type": "string", - "pattern": "^/" - }, - "document": { - "title": "Component export", - "description": "Full component document", - "type": "object" - } - } - } - }, - "referencedComponentHashes": { - "oneOf": [ - { - "type": "array" - }, - { - "type": "null" - } - ], - "items": { - "type": "object", - "additionalProperties": false, - "required": ["type", "reference", "hash", "name"], - "properties": { - "type": { - "type": "string" - }, - "reference": { - "type": "string" - }, - "name": { - "type": "string", - "description": "The last known name of the exported document" - }, - "hash": { - "type": "string" - }, - "query": { - "type": "object" - } - } - } - }, - "referencedComponents": { - "oneOf": [ - { - "type": "array" - }, - { - "type": "null" - } - ], - "items": { - "type": "object", - "additionalProperties": false, - "required": ["type", "reference", "document"], - "properties": { - "type": { - "type": "string" - }, - "reference": { - "type": "string" - }, - "document": { - "title": "Referenced component export", - "description": "Full referenced component document", - "type": "object" - } - } - } - }, - "folders": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "required": ["name", "nodeType", "children"], - "properties": { - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "name": { - "description": "Folder name", - "type": "string", - "examples": ["folder-1", "folder-2"] - }, - "children": { - "type": "array", - "items": { - "oneOf": [ - {}, - { - "type": "object", - "required": ["iid", "nodeType"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string" - } - } - } - ] - } - } - } - }, - { - "type": "object", - "required": ["iid", "nodeType"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string" - } - } - } - ] - } - }, - "created": { - "title": "ISO Date String", - "description": "ISO Date String", - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "createdBy": {}, - "lastUpdated": { - "title": "ISO Date String", - "description": "ISO Date String", - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "lastUpdatedBy": {}, - "versionHistory": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "versionNumber", - "commitMessage", - "author", - "branchName" - ], - "properties": { - "versionNumber": { - "type": "integer", - "examples": [1] - }, - "commitMessage": { - "type": "string" - }, - "author": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - } - } - } - } - } - }, - "automation-studio_projects-http-id": { - "title": "Projects HTTP ID", - "description": "Project identifier as understood by the HTTP API", - "oneOf": [ - { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - } - ] - }, - "automation-studio_projects-http": { - "title": "Project HTTP Data", - "description": "Project data as it is sent back from get and search endpoints", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "_id": { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "name": { - "description": "Project name", - "type": "string", - "examples": [ - "Firewall Service Provisioning", - "Arista EOS Utilities", - "Github" - ] - }, - "description": { - "title": "Project description", - "description": "A free-form block of text for describing project intent and function", - "type": "string", - "examples": [ - "This project is used at Acme Corp as the foundation of some major parts of our business process.", - "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" - ] - }, - "members": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": ["type", "reference", "role"], - "properties": { - "type": { - "type": "string", - "enum": ["account", "group"] - }, - "reference": { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "role": { - "type": "string", - "enum": ["owner", "editor", "operator", "viewer"] - }, - "missing": { - "type": "boolean" - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - } - } - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - }, - "componentIidIndex": { - "title": "Component IID Index", - "description": "Read-only property providing incrementing integer ID values for child components within a project", - "type": "integer", - "minimum": 0 - }, - "components": { - "title": "Project components", - "description": "A list of member components in the project", - "type": "array", - "items": { - "title": "Project component", - "description": "An IAP component which resides within a project", - "type": "object", - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string", - "examples": [ - "1Ac4B2268489019745B5baa4", - "2D772A00dd2Ccedf3bd313bd", - "866a9B98DdD58Ff0e14ebB16" - ] - }, - "folder": { - "title": "Project component folder", - "description": "", - "type": "string", - "pattern": "^/" - } - } - } - }, - "folders": { - "title": "Project folders", - "description": "A list of folders and their members", - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "required": ["name", "nodeType", "children"], - "properties": { - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "name": { - "description": "Folder name", - "type": "string", - "examples": ["folder-1", "folder-2"] - }, - "children": { - "type": "array", - "items": { - "oneOf": [ - {}, - { - "type": "object", - "required": ["iid", "nodeType"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string" - } - } - } - ] - } - } - } - }, - { - "type": "object", - "required": ["iid", "nodeType"], - "properties": { - "iid": { - "title": "IID", - "description": "Incrementing integer ID", - "type": "integer", - "minimum": 0, - "examples": [1, 2, 3, 4, 5] - }, - "nodeType": { - "title": "Project folder node type", - "description": "String denoting the nodeType of the folder node", - "type": "string", - "enum": ["folder", "component"] - }, - "type": { - "title": "Project component type", - "description": "String denoting the type of component", - "type": "string", - "enum": [ - "workflow", - "jsonForm", - "mopAnalyticTemplate", - "mopCommandTemplate", - "template", - "transformation" - ] - }, - "reference": { - "type": "string" - } - } - } - ] - } - }, - "created": { - "title": "ISO Date String", - "description": "ISO Date String", - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "createdBy": {}, - "lastUpdated": { - "title": "ISO Date String", - "description": "ISO Date String", - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "lastUpdatedBy": {}, - "versionHistory": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "versionNumber", - "commitMessage", - "author", - "branchName" - ], - "properties": { - "versionNumber": { - "type": "integer", - "examples": [1] - }, - "commitMessage": { - "type": "string" - }, - "author": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - } - } - } - }, - "gitConfiguration": { - "type": "object", - "additionalProperties": false, - "required": [ - "connectionType", - "repositoryPath", - "branchName", - "projectPath" - ], - "properties": { - "connectionType": { - "type": "string", - "enum": ["GitHub", "GitLab"] - }, - "repositoryPath": { - "type": "string", - "examples": ["Itential Open Source"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - }, - "projectPath": { - "type": "string", - "examples": ["Projects"] - } - } - } - } - }, - "automation-studio_projects-search-parameters": { - "title": "Project Search Parameters", - "description": "Parameters used to filter and paginate Project documents in the Project search API", - "type": "object", - "additionalProperties": true, - "properties": { - "equals": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "iid": { - "type": "number" - }, - "name": { - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "lastUpdatedBy": { - "type": "string" - } - } - }, - "in": { - "type": "object", - "properties": { - "_id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - }, - "iid": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - }, - "name": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - }, - "createdBy": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - } - }, - "starts-with": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "contains": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "name,description": { - "type": "string" - }, - "description,name": { - "type": "string" - } - } - }, - "sort": { - "type": "string", - "enum": [ - "_id", - "iid", - "name", - "created", - "lastUpdated", - "createdBy", - "lastUpdatedBy" - ] - }, - "order": { - "type": "string", - "enum": ["asc", "desc"] - }, - "skip": { - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "limit": { - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] - } - } - }, - "automation-studio_projects-update-data": { - "title": "Project Update Data", - "description": "PATCH body properties used to update a project", - "type": "object", - "additionalProperties": true, - "properties": { - "name": { - "description": "Project name", - "type": "string", - "examples": [ - "Firewall Service Provisioning", - "Arista EOS Utilities", - "Github" - ] - }, - "description": { - "title": "Project description", - "description": "A free-form block of text for describing project intent and function", - "type": "string", - "examples": [ - "This project is used at Acme Corp as the foundation of some major parts of our business process.", - "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally" - ] - }, - "thumbnailBackgroundColor": { - "description": "Thumbnail background color", - "type": "string", - "default": "#FFFFFF" - }, - "members": { - "type": "array", - "items": { - "type": "object", - "required": ["type", "reference", "role"], - "additionalProperties": false, - "properties": { - "type": { - "type": "string", - "enum": ["account", "group"] - }, - "reference": { - "title": "MongoDB ObjectId", - "description": "A string representation of a MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": [ - "62a1f3d2ebedfc54e6e0065c", - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - }, - "role": { - "type": "string", - "enum": ["owner", "editor", "operator", "viewer"] - } - } - } - }, - "version": { - "type": "object", - "additionalProperties": false, - "required": [ - "versionNumber", - "commitMessage", - "author", - "branchName" - ], - "properties": { - "versionNumber": { - "type": "integer", - "examples": [1] - }, - "commitMessage": { - "type": "string" - }, - "author": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - } - } - }, - "gitConfiguration": { - "type": "object", - "additionalProperties": false, - "required": [ - "connectionType", - "repositoryPath", - "branchName", - "projectPath" - ], - "properties": { - "connectionType": { - "type": "string", - "enum": ["GitHub", "GitLab"] - }, - "repositoryPath": { - "type": "string", - "examples": ["Itential Open Source"] - }, - "branchName": { - "type": "string", - "examples": ["master"] - }, - "projectPath": { - "type": "string", - "examples": ["Projects"] - } - } - } - } - }, - "automation-studio_resource-ref-http": { - "title": "ResourceRef HTTP Data", - "description": "The resourceRef objects that are returned from getReferences", - "type": "object", - "additionalProperties": false, - "required": [ - "resourceType", - "resourcePointer", - "resourceId", - "parents" - ], - "properties": { - "resourceType": { - "type": "string" - }, - "resourcePointer": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "root": { - "type": "boolean" - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "resourceType", - "resourcePointer", - "resourceId", - "parentPointer" - ], - "properties": { - "resourceType": { - "type": "string" - }, - "resourcePointer": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "root": { - "type": "boolean" - }, - "parentPointer": { - "type": "string" - } - } - } - }, - "resource": { - "type": "object", - "description": "When using 'includeResources', this property will contain the full resource object" - } - } - }, - "automation-studio_taskDetails": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "The Root Schema", - "required": ["location", "name", "app", "variables"], - "properties": { - "location": { - "type": "string", - "enum": ["Application", "Adapter", "Broker"] - }, - "name": { - "type": "string", - "examples": ["query"] - }, - "app": { - "type": "string", - "examples": ["WorkFlowEngine"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "string", - "number", - "array", - "object", - "enum", - "boolean", - "*" - ] - }, - "description": { - "type": "string", - "examples": ["Example description"] - }, - "schema": { - "type": "object" - } - } - } - }, - "outgoing": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "string", - "number", - "array", - "object", - "enum", - "boolean", - "*" - ] - }, - "description": { - "type": "string", - "examples": ["Example description"] - }, - "schema": { - "type": "object" - } - } - } - } - } - } - } - }, - "automation-studio_template": { - "title": "Template Document", - "description": "An entity representing a data template.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the automation" - }, - "namespace": { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - }, - "name": { - "type": "string", - "examples": ["arista_eos_show_clock"], - "minLength": 1, - "pattern": "^(?!\\s)[\\w\\s]+(? Record\n" - ], - "minLength": 1 - }, - "data": { - "type": "string", - "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], - "minLength": 1 - }, - "type": { - "type": "string", - "examples": ["textfsm", "jinja2"], - "enum": ["textfsm", "jinja2"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the automation" - }, - "created": { - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "lastUpdatedBy": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the automation" - }, - "lastUpdated": { - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "description": "A user-defined object to help group documents.", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "description": "Unique identifier of the automation" - }, - "name": { - "type": "string", - "description": "user-given, unique string to ID tag" - } - } - } - } - }, - "required": [ - "name", - "group", - "command", - "description", - "template", - "data", - "type" - ], - "additionalProperties": false - }, - "automation-studio_templateImport": { - "title": "Template Import Data", - "description": "Data to import as a new template document.", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "Unique identifier of the automation" - }, - "name": { - "type": "string", - "examples": ["arista_eos_show_clock"], - "minLength": 1 - }, - "projectId": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$" - } - ] - }, - "group": { - "type": "string", - "examples": ["Arista"], - "minLength": 1 - }, - "device": { - "type": "string", - "examples": ["Arista EOS"], - "minLength": 1 - }, - "command": { - "type": "string", - "examples": ["show clock"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["Arista Show Clock Info"], - "minLength": 1 - }, - "template": { - "type": "string", - "examples": [ - "Value TIME (d+:d+:d+)\nValue TIMEZONE (S+)\nValue DAYWEEK (w+)\nValue MONTH (w+)\nValue DAY (d+)\nValue YEAR (d+)\n\nStart\n ^${DAYWEEK}s+${MONTH}s+${DAY}s+${TIME}s+${YEAR}\n ^[t|T]imezone(:|sis)s+${TIMEZONE} -> Record\n" - ], - "minLength": 1 - }, - "data": { - "type": "string", - "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], - "minLength": 1 - }, - "text": { - "type": "string", - "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], - "minLength": 1 - }, - "type": { - "type": "string", - "examples": ["textfsm", "jinja2"], - "enum": ["textfsm", "jinja2"] - }, - "createdBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "Unique identifier of the automation" - }, - "created": { - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "lastModifiedBy": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "Unique identifier of the automation" - }, - "lastUpdated": { - "type": "string", - "examples": ["2019-11-25T22:51:39.201Z"], - "format": "date-time" - }, - "version": { - "type": "number", - "examples": [1], - "minimum": 1 - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "description": "A user-defined object to help group documents.", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "description": "Unique identifier of the automation" - }, - "name": { - "type": "string", - "description": "user-given, unique string to ID tag" - } - } - } - } - }, - "oneOf": [ - { - "required": [ - "_id", - "name", - "group", - "command", - "description", - "template", - "data", - "type" - ] - }, - { - "required": [ - "_id", - "name", - "device", - "command", - "template", - "text", - "type" - ] - } - ], - "additionalProperties": false - }, - "automation-studio_templateUpdate": { - "title": "Template Update", - "description": "An entity representing an update to an existing template document.", - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["arista_eos_show_clock"], - "minLength": 1 - }, - "group": { - "type": "string", - "examples": ["Arista"], - "minLength": 1 - }, - "projectId": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$" - } - ] - }, - "command": { - "type": "string", - "examples": ["show clock"], - "minLength": 1 - }, - "description": { - "type": "string", - "examples": ["Arista Show Clock Info"], - "minLength": 1 - }, - "template": { - "type": "string", - "examples": [ - "Value TIME (d+:d+:d+)\nValue TIMEZONE (S+)\nValue DAYWEEK (w+)\nValue MONTH (w+)\nValue DAY (d+)\nValue YEAR (d+)\n\nStart\n ^${DAYWEEK}s+${MONTH}s+${DAY}s+${TIME}s+${YEAR}\n ^[t|T]imezone(:|sis)s+${TIMEZONE} -> Record\n" - ], - "minLength": 1 - }, - "data": { - "type": "string", - "examples": ["Mon Jan 14 18:42:49 2013\ntimezone is US/Central"], - "minLength": 1 - }, - "type": { - "type": "string", - "examples": ["textfsm", "jinja2"], - "enum": ["textfsm", "jinja2"] - } - }, - "required": [ - "name", - "group", - "command", - "description", - "template", - "data", - "type" - ], - "additionalProperties": false - }, - "automation-studio_workflowDocument": { - "title": "workflow document", - "description": "Third generation workflow document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "namespace": { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - }, - "name": { - "type": "string", - "examples": [ - "Port Turn Up IOS", - "Push Config to Device", - "Command Template Runner" - ] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "string", - "examples": ["Port Turn Up IOS", "Push Config to Device"] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "integer", - "title": "Pre automation time of automation", - "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", - "examples": [5000, 250000] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "workflow_end": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [0] - } - } - } - } - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "sla": { - "type": "integer", - "title": "Task SLA", - "description": "Service level agreement for time (milliseconds) that should be spent working manual task.", - "examples": ["3600000"] - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - } - }, - "required": ["incoming", "outgoing", "error"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - }, - "retrySettings": { - "type": "object", - "title": "Retry Settings", - "description": "Retry settings for a task.", - "required": [ - "state", - "autoRetry", - "limit", - "delay" - ], - "properties": { - "state": { - "type": "array", - "title": "State", - "description": "Finish states the task will retry on. The task will retry on any of the included states.", - "items": { - "type": "string", - "enum": ["success", "error", "failure"] - } - }, - "autoRetry": { - "type": "boolean", - "title": "Auto Retry", - "description": "Whether the task is set to retry automatically or manually." - }, - "limit": { - "type": "integer", - "title": "Limit", - "description": "Limit of retries on a task before it will take normal transitions and stop retrying.", - "examples": [10, 20] - }, - "delay": { - "type": "integer", - "title": "Delay", - "description": "Delay between each retry in milliseconds.", - "examples": [1000, 2000] - }, - "count": { - "type": "integer", - "title": "Count", - "description": "Current retry count used for workflow engine job processing", - "examples": [5] - } - }, - "additionalProperties": false - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": {}, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": {}, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For automations with canvasVersion = 1, this field will refer to the version of Workflow Builder. For automations with canvasVersion = 2, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "canvasVersion": { - "type": "number", - "const": 3 - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - } - }, - "additionalProperties": false, - "required": [ - "name", - "type", - "tasks", - "transitions", - "groups", - "canvasVersion" - ] - }, - "automation-studio_workflowDocumentAll": { - "title": "workflow document", - "description": "Accepts all generation workflow documents", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - "name": { - "type": "string", - "examples": [ - "Port Turn Up IOS", - "Push Config to Device", - "Command Template Runner" - ] - }, - "type": { - "type": "string", - "default": "automation" - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "additionalProperties": false, - "required": ["type", "_id", "name", "accessControl"], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "description": "A MongoDB ObjectId", - "type": "object" - }, - "name": { - "type": "string", - "examples": ["Juniper JUNOS", "F5 Big-IP"] - }, - "accessControl": { - "type": "object", - "additionalProperties": false, - "required": ["read", "write", "execute", "manage"], - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["account:67d3108eddcf3e66cc0efbac"] - } - } - } - } - } - } - ] - }, - "description": { - "oneOf": [ - { - "type": "string", - "examples": ["Port Turn Up IOS", "Push Config to Device"] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "number", - "examples": [5000, 250000] - }, - "sla": { - "type": "number", - "examples": [10] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - } - }, - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - } - ] - }, - "workflow_end": { - "type": "object", - "allOf": [ - { - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - } - }, - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string" - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "anyOf": [ - { - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasVersion: 1 workflows", - "examples": [1] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasVersion: 1 workflows", - "examples": [0] - } - } - }, - { - "properties": { - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - } - } - }, - { - "properties": { - "nodeLocation": { - "type": "object", - "description": "Stores the coordinates used by canvasVersion: 3 workflows", - "properties": { - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "additionalProperties": false - }, - "errorHandler": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - ] - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["name", "provenance"] - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": { - "oneOf": [ - { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["username", "provenance"] - }, - { - "type": "null" - } - ] - }, - "createdVersion": { - "type": "string", - "examples": ["5.40.5-2021.1.72.0"] - }, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": { - "oneOf": [ - { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn", "Local AAA"] - } - }, - "required": ["username", "provenance"] - }, - { - "type": "null" - } - ] - }, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "required": ["_id", "name", "description"] - } - }, - "canvasVersion": { - "type": "number", - "enum": [1, 1.5, 2, 3] - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - }, - "inputSchema": { - "type": "object" - }, - "outputSchema": { - "type": "object" - }, - "outputData": { - "type": "object" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "migrationVersion": { - "type": "integer", - "minimum": 0 - } - }, - "additionalProperties": true, - "required": ["name", "type", "tasks", "transitions", "groups"] - }, - "tags_tagDocument_tagName": { - "type": "string", - "examples": ["My Tag"] - }, - "tags_tagDocument_tagId": { - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - }, - "tags_tagDocument_tagDescription": { - "type": "string", - "examples": ["Descriptions can be empty"] - }, - "tags_tagDocument_contentRefId": { - "type": "string", - "examples": ["The id of the content to be referenced"] - }, - "tags_tagDocument_contentRefType": { - "type": "string", - "examples": ["The id of the content to be referenced"] - }, - "tags_tagDocument_tagObject": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - }, - "description": { - "type": "string", - "examples": ["Descriptions can be empty"] - }, - "name": { - "type": "string", - "examples": ["My Tag"] - } - } - }, - "tags_tagDocument_referenceObject": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["new created reference id"] - }, - "tag_id": { - "type": "string", - "examples": ["5c8fa48dd8e04500b1b2f28c"] - }, - "ref_id": { - "type": "string", - "examples": ["The id of the content to be referenced"] - }, - "type": { - "type": "string", - "examples": ["The id of the content to be referenced"] - } - } - }, - "workflow_engine_jobMetricsDocument": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Job metrics schema", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "workflow": { - "type": "object", - "title": "Automation the job was started on.", - "properties": { - "name": { - "type": "string", - "title": "Name of the automation the job was started on", - "examples": ["exampleAutomationName"] - }, - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "Automation objectId the job was started on", - "examples": [ - "4321abcdef694aa79dae47ad", - "5cb7b531d06cceb89fd21b1c" - ] - } - } - }, - "preAutomationTime": { - "type": "integer", - "title": "Pre automation time of automation", - "description": "Time (milliseconds) automation would have taken someone to complete without using IAP.", - "examples": [5000, 250000] - }, - "metrics": { - "type": "array", - "title": "Weekly aggregate metrics", - "description": "Aggregate job metrics collected on a weekly basis", - "items": { - "type": "object", - "properties": { - "jobsComplete": { - "type": "integer", - "title": "Jobs complete for automation", - "description": "Total number of jobs complete for automation for the week starting at startDate.", - "minimum": 0, - "examples": [10, 40] - }, - "totalRunTime": { - "type": "integer", - "title": "Total run time for automation", - "description": "Total run time (milliseconds) of jobs complete for automation for the week starting at startDate.", - "minimum": 0, - "examples": [200, 700] - }, - "totalManualTime": { - "type": "integer", - "title": "Total manual time for automation", - "description": "Total time (milliseconds) spent working manual a task for automation for the week starting at startDate.", - "minimum": 0, - "examples": [200, 700] - }, - "slaTargetsMissed": { - "type": "integer", - "title": "Sla targets missed for automation.", - "description": "Total number of sla targets that were missed for an automation for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - }, - "startDate": { - "type": "string", - "title": "Start DateTime of metric collection", - "description": "Metrics are collected on a weekly interval, starting at startDate", - "examples": [ - "2018-08-02T15:56:12.912Z", - "2019-09-06T12:52:24.933Z" - ] - } - }, - "required": [ - "jobsComplete", - "totalRunTime", - "totalManualTime", - "slaTargetsMissed", - "startDate" - ] - } - } - }, - "required": ["_id", "workflow", "metrics"] - }, - "workflow_engine_taskMetricsDocument": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Default metrics schema", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "app": { - "type": "string", - "title": "The associated app for this task", - "examples": ["WorkflowBuilder"] - }, - "name": { - "type": "string", - "title": "The name of the task", - "examples": ["getTime", "testTask"] - }, - "taskType": { - "type": "string", - "title": "The type of the task", - "enum": ["automatic", "manual", "operation"] - }, - "global": { - "type": "boolean", - "title": "Global task", - "description": "Global designating if metric is global across automations or per-automation.", - "examples": [true, false] - }, - "taskId": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$|^workflow_start$|^workflow_end$", - "title": "Workflow task id", - "description": "Four character hexadecimal task identifier", - "examples": ["12ab", "cd34"] - }, - "workflow": { - "type": "object", - "title": "Automation the job was started on.", - "properties": { - "name": { - "type": "string", - "title": "Name of the automation the job was started on", - "examples": ["exampleAutomationName"] - } - } - }, - "metrics": { - "type": "array", - "title": "Weekly aggregate metrics", - "description": "Aggregate job metrics collected on a weekly basis", - "items": { - "type": "object", - "properties": { - "startDate": { - "type": "string", - "title": "Start DateTime of metric collection", - "description": "Metrics are collected on a weekly interval, starting at startDate.", - "examples": ["2018-08-02T15:56:12.912Z"] - }, - "totalSuccesses": { - "type": "integer", - "title": "Total successes for a task", - "description": "Total number of tasks that ended in status success for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - }, - "totalSuccessRunTime": { - "type": "integer", - "title": "Total successes run time for a task", - "description": "Total run time (milliseconds) for tasks that ended in status success for the week starting at startDate.", - "minimum": 0, - "examples": [550, 200] - }, - "totalErrors": { - "type": "integer", - "title": "Total errors for a task", - "description": "Total number of tasks that ended in status error for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - }, - "totalErrorRunTime": { - "type": "integer", - "title": "Total error run time for a task", - "description": "Total run time (milliseconds) for tasks that ended in status error for the week starting at startDate.", - "minimum": 0, - "examples": [550, 200] - }, - "totalFailures": { - "type": "integer", - "title": "Total failures for a task", - "description": "Total number of tasks that ended in status failure for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - }, - "totalFailureRunTime": { - "type": "integer", - "title": "Total failure run time for a task", - "description": "Total run time (milliseconds) for tasks that ended in status failure for the week starting at startDate.", - "minimum": 0, - "examples": [550, 200] - }, - "slaTargetsMissed": { - "type": "integer", - "title": "Sla targets missed for a manual task", - "description": "Total number of sla targets that were missed for a manual task for the week starting at startDate.", - "minimum": 0, - "examples": [5, 10] - } - }, - "required": [ - "startDate", - "totalSuccesses", - "totalSuccessRunTime", - "totalErrorRunTime", - "totalErrors", - "totalFailureRunTime", - "totalFailures" - ] - } - } - }, - "required": [ - "_id", - "app", - "name", - "type", - "taskType", - "global", - "metrics" - ] - }, - "workflow_engine_wfEngineCommon_skip": { - "type": "integer", - "description": "The number of documents skipped before returning data. When 0, no data is skipped.", - "minimum": 0, - "examples": [0] - }, - "workflow_engine_wfEngineCommon_limit": { - "type": "integer", - "title": "The returned document limit", - "description": "Specifies a limit to the maximum number of data results returned.", - "minimum": 0, - "maximum": 100, - "examples": [50] - }, - "workflow_engine_wfEngineCommon_sort": { - "type": "string", - "description": "Field to sort by. Default is workflow.name.", - "default": "workflow.name" - }, - "workflow_engine_wfEngineCommon_order": { - "type": "integer", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "default": 1, - "enum": [-1, 1] - }, - "workflow_engine_wfEngineCommon_total": { - "type": "integer", - "description": "The total number of documents returned from a search.", - "minimum": 0, - "examples": [100] - }, - "workflow_engine_wfEngineCommon_evaluationItem": { - "type": "object", - "title": "Evaluation Object", - "description": "Contains all the items/properties needed for a comparison operation/evaluation", - "required": ["operand_1", "operator", "operand_2"], - "properties": { - "query": { - "type": "string", - "title": "Query for first operand", - "description": "Query the operand_1 (optional)", - "examples": [ - "somePropertyNameInOperand_1IfItIsAnObject.nestedProperty" - ] - }, - "rightQuery": { - "type": "string", - "title": "Query for second operand", - "description": "Query the operand_2 (optional)", - "examples": [ - "somePropertyNameInOperand_2IfItIsAnObject.nestedProperty" - ] - }, - "operand_1": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "boolean" - }, - { - "type": "number" - } - ], - "title": "A comparison value", - "description": "Used in evaluations as either the object to compare, or the object to compare to" - }, - "operator": { - "type": "string", - "enum": ["contains", "!contains", "<", "<=", ">", ">=", "==", "!="], - "title": "The Operator ", - "description": "The operation (contains, !contains, <,<=, etc)", - "examples": ["contains"] - }, - "operand_2": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "boolean" - }, - { - "type": "number" - } - ], - "title": "A comparison value", - "description": "Used in evaluations as either the object to compare, or the object to compare to" - } - } - }, - "workflow_engine_wfEngineCommon_mongoObjectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$", - "title": "MongoDB ObjectID", - "description": "String representation of a MongoDB ObjectId", - "examples": ["4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c"] - }, - "json-forms_formBindingSchema_bindingSchema": { - "type": "object" - }, - "json-forms_formDocument_form": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2019-04-16T00:43:22.038Z"] - }, - "createdBy": { - "type": "string", - "examples": ["5cb08d4f16640f00182c3890"] - }, - "lastUpdated": { - "type": "string", - "format": "date-time", - "examples": ["2019-04-16T00:43:22.038Z"] - }, - "lastUpdatedBy": { - "type": "string", - "examples": ["5cb08d4f16640f00182c3890"] - }, - "name": { - "type": "string", - "examples": ["Device Form"] - }, - "tags": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - { - "type": "object" - } - ] - } - }, - "description": { - "anyOf": [ - { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - { - "type": "null" - } - ] - }, - "struct": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "projectId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "required": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "array" - } - ] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "This section describes the connection information for a device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": [ - "Enter connection retry attempt count" - ] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - }, - "collapsed": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "schemaOption": { - "type": "boolean" - }, - "combinationType": { - "type": "string" - }, - "widget": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "items"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "required": ["type", "items"], - "additionalProperties": false, - "definitions": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "container": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "required": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "array" - } - ] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "This section describes the connection information for a device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "required": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "array" - } - ] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "This section describes the connection information for a device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": [ - "Enter connection retry attempt count" - ] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": [ - "Tooltip help message goes here" - ] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - }, - "collapsed": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "schemaOption": { - "type": "boolean" - }, - "combinationType": { - "type": "string" - }, - "widget": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "items"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": [ - "Enter connection retry attempt count" - ] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - }, - "collapsed": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "schemaOption": { - "type": "boolean" - }, - "combinationType": { - "type": "string" - }, - "widget": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "items"], - "additionalProperties": false - }, - "checkboxField": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": ["Is a timeout allowed to pass this step?"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - }, - "numberField": { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - "textField": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - "textareaField": { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - "dropdownField": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - "fileUploadField": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - } - } - }, - "schema": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "readOnly": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file."] - }, - "format": { - "type": "string", - "const": "data-url" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - } - }, - "readOnly": { - "type": "boolean" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - } - } - }, - "anyOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "oneOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "allOf": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["type", "title"] - }, - "uiSchema": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "ui:widget": { - "type": "string", - "const": "updown" - } - }, - "required": ["ui:widget"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's config"] - }, - "ui:widget": { - "type": "string", - "const": "textarea" - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Select device"] - } - } - } - ] - } - } - }, - "validationSchema": { - "type": "object" - }, - "bindingSchema": { - "type": "object" - }, - "version": { - "type": "string", - "examples": ["2020.1"] - }, - "id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ] - } - }, - "required": [ - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy", - "name", - "description", - "struct", - "schema", - "uiSchema", - "bindingSchema", - "validationSchema", - "version" - ], - "additionalProperties": false - }, - "json-forms_formDocument_formId": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "json-forms_formDocument_formData": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - }, - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ] - } - } - }, - "json-forms_formDocument_validationResponse": { - "type": "object", - "properties": { - "status": { - "type": "integer", - "enum": [200, 404] - }, - "validation": { - "type": "object", - "properties": { - "valid": { - "type": "boolean" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "message": { - "type": "string", - "examples": ["Form data is valid."] - } - } - }, - "json-forms_formDocument_importResultReport": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2019-04-16T00:43:22.038Z"] - }, - "createdBy": { - "type": "string", - "examples": ["5cb08d4f16640f00182c3890"] - }, - "lastUpdated": { - "type": "string", - "format": "date-time", - "examples": ["2019-04-16T00:43:22.038Z"] - }, - "lastUpdatedBy": { - "type": "string", - "examples": ["5cb08d4f16640f00182c3890"] - }, - "name": { - "type": "string", - "examples": ["Device Form"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - } - } - }, - "json-forms_formSchema_container": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "readOnly": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "readOnly": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file."] - }, - "format": { - "type": "string", - "const": "data-url" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - } - }, - "readOnly": { - "type": "boolean" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - } - } - } - }, - "anyOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "oneOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "allOf": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["type", "title"] - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": ["Is a timeout allowed to pass this step?"] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file."] - }, - "format": { - "type": "string", - "const": "data-url" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - } - }, - "readOnly": { - "type": "boolean" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "description": { - "type": "string", - "examples": [ - "This form describes the connection information for a device." - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "readOnly": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "properties": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file."] - }, - "format": { - "type": "string", - "const": "data-url" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": [ - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - } - }, - "items": {}, - "anyOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "oneOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "allOf": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["type", "title"] - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "default": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "type": "boolean" - } - }, - "readOnly": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "minimum": { - "type": "number" - }, - "maximum": { - "type": "number" - }, - "default": { - "type": "number" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "placeholder": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "options": { - "type": "object" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "readOnly": { - "type": "boolean" - }, - "placeholder": { - "type": "string" - }, - "binding": { - "type": "boolean" - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [["kdWO-g4oS3GkzrbqDqCZUw"]] - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - } - }, - "required": ["type", "title", "description"], - "additionalProperties": false - } - ] - } - } - } - } - }, - "anyOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "oneOf": { - "type": "array", - "items": { - "type": "object" - } - }, - "allOf": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": ["type", "title"] - }, - "json-forms_formStruct": { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "projectId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Connection Information"] - }, - "required": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "array" - } - ] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "This section describes the connection information for a device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "items": { - "type": "array", - "items": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": [ - "Is a timeout allowed to pass this step?" - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": [ - "Enter connection retry attempt count" - ] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": [ - "A unique name of the target device." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": [ - "nodeId", - "type", - "title", - "description" - ], - "additionalProperties": false - } - ] - } - }, - "collapsed": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "schemaOption": { - "type": "boolean" - }, - "combinationType": { - "type": "string" - }, - "widget": { - "type": "string" - }, - "uniqueItems": { - "type": "boolean" - }, - "minItems": { - "type": "number" - }, - "maxItems": { - "type": "number" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "items"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "type": { - "type": "string", - "const": "boolean" - }, - "required": { - "type": "boolean" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Allow timeout"] - }, - "description": { - "type": "string", - "examples": ["Is a timeout allowed to pass this step?"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "default": { - "type": "boolean", - "examples": [false] - }, - "enum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "value": { - "type": "boolean" - } - } - } - }, - "readOnly": { - "type": "boolean" - }, - "widget": { - "type": "string" - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "number" - }, - "widget": { - "type": "string" - }, - "options": { - "type": "object" - }, - "title": { - "type": "string", - "examples": ["Retry attempts"] - }, - "description": { - "type": "string", - "examples": [ - "The number of connection retries before timing out." - ] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "required": { - "type": "boolean" - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "minimum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "maximum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "default": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ] - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "binding": { - "type": "boolean" - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "widget": { - "type": "string" - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "minLength": { - "type": "integer" - }, - "maxLength": { - "type": "integer" - }, - "default": { - "type": "string" - }, - "disabled": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "placeholder", - "required" - ], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "title": { - "type": "string", - "examples": ["Device Name"] - }, - "options": { - "type": "object" - }, - "description": { - "type": "string", - "examples": ["A unique name of the target device."] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - }, - "required": { - "type": "boolean" - }, - "enum": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "default": [] - }, - "enumNames": { - "type": "array", - "items": { - "type": "object" - }, - "default": [] - }, - "binding": { - "type": "boolean", - "default": false - }, - "pattern": { - "type": "string", - "examples": ["regex"] - }, - "rel": { - "type": "string" - }, - "targetPointer": { - "type": "string" - }, - "method": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["GET"] - }, - "body": { - "type": "object" - }, - "sourcePointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/"] - }, - "sourceKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "labelKeyPointer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["/name"] - }, - "base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["http://www.google.com/"] - }, - "href": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "examples": ["api/v1/devices"] - }, - "validation": { - "type": ["object", "array"] - }, - "readOnly": { - "type": "boolean" - }, - "transformation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - }, - { - "type": "object" - } - ] - }, - "disabled": { - "type": "boolean" - }, - "default": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "widget": { - "type": "string" - }, - "radio": { - "type": "boolean" - }, - "inline": { - "type": "boolean" - } - }, - "required": [ - "nodeId", - "type", - "title", - "description", - "required" - ] - }, - { - "type": "object", - "properties": { - "nodeId": { - "type": "string", - "examples": ["kdWO-g4oS3GkzrbqDqCZUw"] - }, - "type": { - "type": "string", - "const": "string" - }, - "title": { - "type": "string", - "examples": ["File Upload"] - }, - "description": { - "type": "string", - "examples": ["Upload a file"] - }, - "helper": { - "type": "string", - "examples": ["Tooltip help message goes here"] - }, - "required": { - "type": "boolean" - }, - "format": { - "type": "string", - "const": "data-url" - }, - "customKey": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "required": ["nodeId", "type", "title", "description"], - "additionalProperties": false - } - ] - } - } - }, - "required": ["type", "items"], - "additionalProperties": false - }, - "json-forms_formUISchema_container": { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - { - "type": "object", - "patternProperties": { - ".*": { - "anyOf": [ - {}, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "ui:widget": { - "type": "string", - "const": "updown" - } - }, - "required": ["ui:widget"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's config"] - }, - "ui:widget": { - "type": "string", - "const": "textarea" - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Select device"] - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter connection retry attempt count"] - }, - "ui:widget": { - "type": "string", - "const": "updown" - } - }, - "required": ["ui:widget"], - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's name"] - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Enter the device's config"] - }, - "ui:widget": { - "type": "string", - "const": "textarea" - } - }, - "additionalProperties": false - }, - { - "type": "object", - "properties": { - "ui:placeholder": { - "type": "string", - "examples": ["Select device"] - } - } - } - ] - } - } - }, - "json-forms_formValidationSchema_validationSchema": { - "type": "object" - }, - "json-forms_metaSchema": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "type": "object", - "properties": { - "$id": { - "type": "string", - "format": "uri-reference" - }, - "$schema": { - "type": "string", - "format": "uri" - }, - "$ref": { - "type": "string", - "format": "uri-reference" - }, - "$comment": { - "type": "string" - }, - "title": { - "type": "string" - }, - "description": { - "type": "string" - }, - "default": {}, - "readOnly": { - "type": "boolean", - "default": false - }, - "examples": { - "type": "array", - "items": {} - }, - "multipleOf": { - "type": "number", - "exclusiveMinimum": 0 - }, - "maximum": { - "type": "number" - }, - "exclusiveMaximum": { - "type": "number" - }, - "minimum": { - "type": "number" - }, - "exclusiveMinimum": { - "type": "number" - }, - "maxLength": { - "type": "integer", - "minimum": 0 - }, - "minLength": { - "allOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "default": 0 - } - ] - }, - "pattern": { - "type": "string", - "format": "regex" - }, - "additionalItems": {}, - "items": { - "anyOf": [ - {}, - { - "type": "array", - "minItems": 1, - "items": {} - } - ], - "default": true - }, - "maxItems": { - "type": "integer", - "minimum": 0 - }, - "minItems": { - "allOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "default": 0 - } - ] - }, - "uniqueItems": { - "type": "boolean", - "default": false - }, - "contains": {}, - "maxProperties": { - "type": "integer", - "minimum": 0 - }, - "minProperties": { - "allOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "default": 0 - } - ] - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true, - "default": [] - }, - "additionalProperties": {}, - "definitions": { - "type": "object", - "additionalProperties": {}, - "default": {} - }, - "properties": { - "type": "object", - "additionalProperties": {}, - "default": {} - }, - "patternProperties": { - "type": "object", - "additionalProperties": {}, - "propertyNames": { - "format": "regex" - }, - "default": {} - }, - "dependencies": { - "type": "object", - "additionalProperties": { - "anyOf": [ - {}, - { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true, - "default": [] - } - ] - } - }, - "propertyNames": {}, - "const": {}, - "enum": { - "type": "array", - "items": {}, - "minItems": 1, - "uniqueItems": true - }, - "type": { - "anyOf": [ - { - "enum": [ - "array", - "boolean", - "integer", - "null", - "number", - "object", - "string" - ] - }, - { - "type": "array", - "items": { - "enum": [ - "array", - "boolean", - "integer", - "null", - "number", - "object", - "string" - ] - }, - "minItems": 1, - "uniqueItems": true - } - ] - }, - "format": { - "type": "string" - }, - "contentMediaType": { - "type": "string" - }, - "contentEncoding": { - "type": "string" - }, - "if": {}, - "then": {}, - "else": {}, - "allOf": { - "type": "array", - "minItems": 1, - "items": {} - }, - "anyOf": { - "type": "array", - "minItems": 1, - "items": {} - }, - "oneOf": { - "type": "array", - "minItems": 1, - "items": {} - }, - "not": {} - } - } - ] - }, - "workflow_builder_workflowDocument": { - "title": "workflow document", - "description": "A workflow document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - "name": { - "type": "string", - "examples": ["My Workflow"] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - } - } - } - } - } - ] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - }, - "workflow_end": { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "x": { - "type": "number", - "examples": [10] - }, - "y": { - "type": "number", - "examples": [20] - } - } - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "additionalProperties": false - }, - "errorHandler": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - ] - }, - "font_size": { - "type": "integer", - "default": 12, - "multipleOf": 2, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "created": { - "type": "string", - "format": "date-time" - }, - "created_by": {}, - "createdVersion": { - "type": "string", - "examples": ["5.40.5-2021.1.72.0"] - }, - "last_updated": { - "type": "string", - "format": "date-time" - }, - "last_updated_by": {}, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "canvasVersion": { - "type": "number", - "enum": [1, 1.5, 2, 3] - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - }, - "inputSchema": { - "type": "object" - }, - "outputSchema": { - "type": "object" - }, - "outputData": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "taskId": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$" - }, - "taskPointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "additionalProperties": false, - "required": ["name", "type", "tasks", "transitions", "groups"] - }, - "workflow_builder_workflowDocument_workflowName": { - "type": "string", - "examples": ["My Workflow"] - }, - "workflow_builder_workflowDocument_anyTask": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string", - "pattern": "^Pronghorn|\\$var\\.job\\.[a-zA-Z_0-9]{1,}|\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - } - ] - }, - "workflow_builder_workflowPayload": { - "title": "workflow import payload", - "description": "A workflow import payload, that has expanded users and groups for transportation between environments", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" - }, - "name": { - "type": "string", - "examples": ["ciscoIOSSoftwareUpgrade", "infobloxCreateARecord"] - }, - "type": { - "type": "string", - "default": "automation" - }, - "description": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": [ - "Upgrade Cisco IOS device", - "Infoblox Create A Record" - ] - } - ] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string", - "examples": ["New Relic", "Cisco", "AWS/EC2"] - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "execute": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "write": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - }, - "manage": { - "type": "array", - "items": { - "type": "string", - "examples": ["677c243acf96f9b4484a78ae"] - } - } - } - } - } - } - ] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_start$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_start$" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - }, - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [5] - } - } - }, - "workflow_end": { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "^workflow_end$" - }, - "summary": { - "type": "string", - "pattern": "^workflow_end$" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - }, - "x": { - "type": "number", - "examples": [1] - }, - "y": { - "type": "number", - "examples": [10] - } - } - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - }, - { - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "manual" - }, - "view": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": ["type", "view", "groups"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "automatic" - }, - "actor": { - "type": "string" - } - }, - "required": ["type", "actor"] - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows", - "examples": [0] - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows", - "examples": [100] - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number", - "examples": [0] - }, - "y": { - "type": "number", - "examples": [1] - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": [ - "Query", - "Transformation", - "Eval", - "Get Device", - "View Data" - ] - }, - "summary": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "description": { - "type": "string", - "examples": [ - "Query Data Using 'json-query' Format", - "JSON Transformation", - "View Data" - ] - }, - "app": { - "type": "string", - "examples": ["Tools", "WorkflowEngine", "Array"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - } - }, - "required": ["incoming", "outgoing"] - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - } - }, - "required": [ - "name", - "summary", - "description", - "app", - "variables", - "groups", - "x", - "y" - ] - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "operation" - } - }, - "required": ["type"] - } - ] - } - ] - } - }, - "required": ["workflow_start", "workflow_end"], - "additionalProperties": false - }, - "transitions": { - "type": "object", - "properties": { - "workflow_start": { - "type": "object" - }, - "workflow_end": { - "type": "object" - }, - "error_handler": { - "type": "object" - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "type": "object" - } - }, - "additionalProperties": false - }, - "errorHandler": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - ] - }, - "font_size": { - "type": "integer", - "default": 12, - "minimum": 6, - "maximum": 24 - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["Admin"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["name", "provenance"] - } - }, - "created": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "created_by": { - "oneOf": [ - { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["username", "provenance"] - }, - { - "type": "null" - } - ] - }, - "createdVersion": { - "type": "string", - "examples": ["5.40.5-2021.1.72.0"] - }, - "last_updated": { - "type": "string", - "format": "date-time", - "examples": ["2024-03-13T18:21:15.352Z"] - }, - "last_updated_by": { - "oneOf": [ - { - "type": "object", - "properties": { - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "provenance": { - "type": "string", - "examples": ["Pronghorn"] - } - }, - "required": ["username", "provenance"] - }, - { - "type": "null" - } - ] - }, - "lastUpdatedVersion": { - "type": "string", - "description": "This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.", - "examples": ["4.69.69"] - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "required": ["_id", "name", "description"] - } - }, - "canvasVersion": { - "type": "number", - "enum": [1, 1.5, 2, 3] - }, - "encodingVersion": { - "type": "integer", - "enum": [1] - }, - "inputSchema": { - "type": "object" - }, - "outputSchema": { - "type": "object" - }, - "outputData": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "taskId": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$" - }, - "taskPointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["encryption"] - }, - "pointer": { - "type": "string", - "format": "json-pointer", - "examples": ["/outgoing/output"] - } - } - } - }, - "migrationVersion": { - "type": "integer", - "minimum": 0 - } - }, - "additionalProperties": false, - "required": ["name", "type", "tasks", "transitions", "groups"] - }, - "template_builder_parseTemplateInput": { - "title": "parse template input", - "description": "The text data to be parse and the textfsm template", - "type": "object", - "properties": { - "text": { - "type": "string", - "examples": ["hostname"] - }, - "template": { - "title": "template document", - "description": "A template document", - "type": "object", - "properties": { - "_id": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "name": { - "type": "string", - "examples": ["My Template"] - }, - "device": { - "type": "string", - "examples": ["Device Group A"] - }, - "command": { - "type": "string", - "examples": ["show hostname"] - }, - "template": { - "type": "string", - "examples": [ - "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record" - ] - }, - "text": { - "type": "string", - "examples": ["hostname"] - }, - "type": { - "type": "string", - "const": "custom" - } - }, - "required": [ - "name", - "device", - "command", - "template", - "text", - "type" - ], - "definitions": { - "templateName": { - "type": "string", - "examples": ["My Template"] - }, - "groupName": { - "type": "string", - "examples": ["Device Group A"] - }, - "command": { - "type": "string", - "examples": ["show hostname"] - }, - "template": { - "type": "string", - "examples": [ - "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record" - ] - }, - "text": { - "type": "string", - "examples": ["hostname"] - }, - "ObjectId": { - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - "required": ["text", "template"] - }, - "operations-manager_automation-api": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Automation Document", - "description": "An Automation document in API response format.", - "required": [ - "name", - "description", - "componentType", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "_id", - "gbac" - ], - "oneOf": [ - { - "required": ["componentId"], - "not": { - "required": ["componentName"] - } - }, - { - "required": ["componentName"], - "not": { - "required": ["componentId"] - } - }, - { - "required": ["componentId", "componentName"] - } - ], - "propertyNames": { - "anyOf": [ - { - "enum": ["name", "description", "componentType"] - }, - { - "enum": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] - }, - { - "enum": ["_id", "gbac", "componentName", "componentId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group ids that have write access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "read": { - "type": "array", - "description": "An array of group ids that have read/execute access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "componentId": { - "description": "The id of the component linked to this Automation.", - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - }, - { - "const": "" - } - ] - }, - "componentName": { - "description": "The name of the component linked to this Automation.", - "oneOf": [ - { - "type": "string", - "examples": ["addDuration", "getJobMetrics"] - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - "operations-manager_automation-common_commonFields": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - "operations-manager_automation-common_gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group ids that have write access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "read": { - "type": "array", - "description": "An array of group ids that have read/execute access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "operations-manager_automation-common_componentId": { - "description": "The id of the component linked to this Automation.", - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - }, - { - "const": "" - } - ] - }, - "operations-manager_automation-create": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Automation Create", - "description": "The format of accepted input for the creation of an Automation document.", - "required": ["name"], - "propertyNames": { - "anyOf": [ - { - "enum": ["name", "description", "componentType"] - }, - { - "enum": [ - "gbac", - "componentId", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy", - "componentName" - ] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group ids that have write access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "read": { - "type": "array", - "description": "An array of group ids that have read/execute access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "componentId": { - "description": "The id of the component linked to this Automation.", - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - }, - { - "const": "" - } - ] - } - } - } - ] - }, - "operations-manager_automation-json": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Automation Document", - "description": "An Automation document in JSON/export format.", - "required": [ - "name", - "description", - "componentType", - "_id", - "gbac", - "componentName" - ], - "propertyNames": { - "anyOf": [ - { - "enum": ["name", "description", "componentType"] - }, - { - "enum": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] - }, - { - "enum": ["_id", "gbac", "triggers", "componentName"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group objects that have write access to the Automation.", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "examples": ["ldap", "localAAA"] - }, - "name": { - "type": "string", - "examples": ["operators", "admins", "designers"] - }, - "description": { - "type": "string", - "examples": ["Description of a group"] - } - }, - "required": ["provenance", "name", "description"] - } - }, - "read": { - "type": "array", - "description": "An array of group objects that have read/execute access to the Automation.", - "items": { - "type": "object", - "properties": { - "provenance": { - "type": "string", - "examples": ["ldap", "localAAA"] - }, - "name": { - "type": "string", - "examples": ["operators", "admins", "designers"] - }, - "description": { - "type": "string", - "examples": ["Description of a group"] - } - }, - "required": ["provenance", "name", "description"] - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "triggers": { - "type": "array", - "items": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger", - "description": "An Endpoint Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "verb", - "routeName", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger", - "description": "An EventSystem Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "source", - "topic", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "source", - "topic", - "schema", - "legacyWrapper" - ] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger", - "description": "A Manual Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "formData", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper" - ] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Triggers Schema for JSON Representation", - "description": "Schema for a Schedule Trigger JSON representation", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "formData", - "firstRunAt", - "processMissedRuns", - "repeatUnit", - "repeatFrequency", - "repeatInterval", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": [ - "repeating", - "terminating" - ] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [ - 30, 140, 2000 - ] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [ - 10000, 30000, 100000 - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [ - 30, 140, 2000 - ] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [ - 10000, 30000, 100000 - ] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - } - }, - "componentName": { - "description": "The name of the component linked to this Automation.", - "oneOf": [ - { - "type": "string", - "examples": ["addDuration", "getJobMetrics"] - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - "operations-manager_automation-update": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Automation Updates", - "description": "The format of accepted input for an update operation on an Automation document.", - "propertyNames": { - "anyOf": [ - { - "enum": ["name", "description", "componentType"] - }, - { - "enum": [ - "gbac", - "componentId", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy", - "componentName" - ] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "componentType": { - "description": "The type of component linked to this Automation.", - "oneOf": [ - { - "const": "workflows" - }, - { - "const": "ucm_compliance_plans" - }, - { - "const": "resource_models" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "gbac": { - "type": "object", - "properties": { - "write": { - "type": "array", - "description": "An array of group ids that have write access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "read": { - "type": "array", - "description": "An array of group ids that have read/execute access to the Automation.", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "required": ["write", "read"], - "additionalProperties": false - }, - "componentId": { - "description": "The id of the component linked to this Automation.", - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - }, - { - "const": "" - } - ] - } - } - } - ] - }, - "operations-manager_common-api_pagination-metadata": { - "description": "Properties describing search result pagination", - "type": "object", - "properties": { - "skip": { - "type": "integer" - }, - "limit": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "nextPageSkip": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "integer" - } - ] - }, - "previousPageSkip": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "integer" - } - ] - }, - "currentPageSize": { - "type": "integer" - } - } - }, - "operations-manager_common-api_success-response": { - "description": "A success response from an API method", - "type": "object", - "additionalProperties": false, - "required": ["message", "data", "metadata"], - "properties": { - "message": { - "description": "A human-readable message summarizing the result of the operation", - "type": "string", - "examples": [ - "Successfully created the requested item", - "Successfully imported 3 of 4 documents", - "Successfully retrieved search results", - "Successfully added group 679cebd0502a4abd9a57a6ba to job 13861e352afe454d89cccfb8", - "Successfully canceled all jobs" - ] - }, - "data": { - "description": "Any successfully retrieved information related to the request." - }, - "metadata": { - "description": "Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.", - "type": "object", - "additionalProperties": true - } - } - }, - "operations-manager_common-api_getJobsQueryParameters": { - "title": "getJobsQueryParameters", - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - }, - "skip": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - }, - "order": { - "type": "integer", - "description": "Sort direction, 1 for ascending and -1 for descending.", - "default": 1, - "enum": [-1, 1] - }, - "sort": { - "type": "string", - "description": "Field to sort by", - "default": "name", - "enum": ["name"] - }, - "include": { - "type": "string", - "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", - "examples": ["name", "description", "name,description"] - }, - "exclude": { - "type": "string", - "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", - "examples": ["_id", "description", "_id,description"] - }, - "in": { - "description": "Search for fields exactly matching one of the given list options", - "type": "string" - }, - "not-in": { - "description": "Search for fields not exactly matching one of the given list options", - "type": "string" - }, - "equals": { - "description": "Returns results where the specified fields exactly match the given match string(s).", - "type": "string" - }, - "contains": { - "description": "Returns results where the specified fields contain the given match string(s). When used on the 'description' field, returns results containing any matching whole word, delimited by most punctuation. Double-quotes may be used to match phrases rather than individual words.", - "type": "string" - }, - "starts-with": { - "description": "Returns results where the specified fields start with the given match string(s).", - "type": "string" - }, - "ends-with": { - "description": "Returns results where the specified fields end in the given match string(s).", - "type": "string" - }, - "dereference": { - "description": "Designates foreign key fields to dereference in the API output.", - "type": "string" - }, - "gt": { - "description": "Returns results where the specified fields have values greater than the specified values.", - "type": "string" - }, - "gte": { - "description": "Returns results where the specified fields have values greater than or equal to the specified values.", - "type": "string" - }, - "lt": { - "description": "Returns results where the specified fields have values less than the specified values.", - "type": "string" - }, - "lte": { - "description": "Returns results where the specified fields have values less than or equal to the specified values.", - "type": "string" - }, - "q": { - "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", - "type": "string" - }, - "exists": { - "description": "Returns results where the specified fields exist according to the specified value.", - "type": "string" - } - } - }, - "operations-manager_common-api_simplePluralSearchQueryParameters": { - "type": "object", - "properties": { - "contains": { - "type": "string", - "examples": ["event"], - "description": "The value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document" - }, - "containsField": { - "type": "string", - "examples": ["name"], - "description": "The field to run a contains query on" - }, - "equals": { - "type": "string", - "examples": ["my event trigger"], - "description": "The value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document" - }, - "equalsField": { - "type": "string", - "examples": ["name"], - "description": "The field to run an equals query on" - }, - "startsWith": { - "type": "string", - "examples": ["my"], - "description": "The value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document" - }, - "startsWithField": { - "type": "string", - "examples": ["name"], - "description": "The field to run a startsWith query on" - }, - "limit": { - "type": "integer", - "description": "Number of results to return. Used for pagination.", - "default": 25, - "minimum": 0, - "examples": [1, 10, 50] - }, - "skip": { - "type": "integer", - "description": "Number of results to skip. Used for pagination.", - "default": 0, - "minimum": 0, - "examples": [1, 10, 50] - }, - "order": { - "type": "integer", - "description": "The sort direction: 1 for ascending or -1 for descending.", - "default": 1, - "enum": [-1, 1] - }, - "sort": { - "type": "string", - "description": "Field to sort by. Default is name.", - "default": "name", - "enum": ["name"] - } - } - }, - "operations-manager_common_name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "operations-manager_common_ObjectIdLikeString": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "operations-manager_common_uuid-v4": { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - "operations-manager_common_decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "operations-manager_common_metadataFields": { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "operations-manager_eventSystem-trigger-common_source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "operations-manager_eventSystem-trigger-common_topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "operations-manager_job-api": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Job Document", - "description": "A Job document in API response format.", - "$comment": "No required fields, because projection operators can result in any combination of fields", - "required": [], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "_id", - "font_size", - "type", - "created", - "last_updated", - "createdVersion", - "lastUpdatedVersion", - "canvasVersion", - "encodingVersion", - "migrationVersion", - "name", - "description", - "preAutomationTime", - "sla", - "decorators", - "transitions", - "status", - "variables", - "tags", - "error", - "warnings", - "ancestors", - "validationErrors", - "namespace" - ] - }, - { - "enum": [ - "created_by", - "last_updated_by", - "tasks", - "parent", - "errorHandler", - "groups", - "watchers", - "metrics", - "output", - "outputData", - "errors", - "warnings" - ] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "font_size": { - "type": "integer", - "examples": [12, 13, 14] - }, - "type": { - "enum": ["automation", "resource:action", "resource:compliance"] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "last_updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "createdVersion": { - "type": "string", - "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$", - "examples": ["5.55.5"] - }, - "lastUpdatedVersion": { - "type": "string", - "pattern": "^\\d+\\.\\d+\\.\\d+(-\\d{4}\\.\\d+\\.\\d+(\\.\\d+)?)?$", - "examples": ["5.55.6"] - }, - "canvasVersion": { - "enum": [1, 1.5, 2, 3] - }, - "encodingVersion": { - "enum": [1] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "oneOf": [ - { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - { - "type": "null" - } - ] - }, - "preAutomationTime": { - "type": "number", - "examples": [0] - }, - "sla": { - "type": "number", - "examples": [0] - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - }, - "transitions": { - "type": "object" - }, - "status": { - "enum": [ - "error", - "complete", - "running", - "canceled", - "incomplete", - "paused" - ] - }, - "variables": { - "type": "object", - "examples": [ - { - "initiator": { - "location": "job_data", - "_id": "67be20c2dda0df69ebe60826" - }, - "_id": { - "location": "job_data", - "_id": "67be20c2dda0df69ebe60825" - } - } - ] - }, - "tags": { - "type": "array" - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "const": "job" - }, - { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["workflow_start", "e28f", "3a1f"] - } - ] - } - ] - }, - "message": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - } - ] - }, - "timestamp": { - "type": "number", - "description": "The time at which this error occurred, designated by a unix timestamp" - } - }, - "examples": [ - { - "task": "f9a9", - "message": { - "code": 500, - "message": { - "apiVersion": "1", - "method": "transformations.run", - "error": { - "code": 500, - "message": "Missing one of the following required instances: arg2, arg1", - "errors": [{}] - } - } - }, - "timestamp": 1627323002561 - }, - { - "task": "job", - "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", - "timestamp": 1627323002574 - } - ] - } - }, - "warnings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["workflow_start", "e28f", "3a1f"] - } - ] - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "message": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string" - } - ] - } - } - } - }, - "ancestors": { - "oneOf": [ - { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "type": "null" - } - ] - }, - "validationErrors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "keyword": { - "type": "string" - }, - "instancePath": { - "type": "string" - }, - "schemaPath": { - "type": "string" - }, - "params": { - "type": "object" - }, - "message": { - "type": "string" - } - } - } - }, - "namespace": { - "type": "object" - } - } - }, - { - "type": "object", - "properties": { - "created_by": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - "last_updated_by": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - "tasks": { - "type": "object", - "properties": { - "workflow_start": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "workflow_start" - }, - "summary": { - "const": "workflow_start" - }, - "taskId": { - "const": "workflow_start" - }, - "metrics": { - "type": "object", - "properties": { - "start_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "metrics": { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - } - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - }, - "workflow_end": { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "workflow_end" - }, - "summary": { - "const": "workflow_end" - }, - "taskId": { - "const": "workflow_end" - }, - "endTasks": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "metrics": { - "type": "object", - "properties": { - "end_time": { - "type": "number" - }, - "run_time": { - "type": "number" - } - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - }, - "error_handler": { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "operation" - }, - "canvasName": { - "not": { - "const": "childJob" - } - } - } - } - ] - }, - { - "type": "object", - "properties": { - "name": { - "const": "childJob" - } - } - } - ] - }, - { - "type": "object", - "properties": { - "actor": { - "oneOf": [ - { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - { - "const": "job" - } - ] - }, - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - } - }, - "patternProperties": { - "^[0-9a-f]{1,4}$": { - "allOf": [ - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "view": { - "type": "string" - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "automatic" - }, - "actor": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "const": "job" - }, - { - "$comment": "Job variable", - "type": "string", - "pattern": "^\\$var\\.job\\.[a-zA-Z_0-9]{1,}$" - }, - { - "$comment": "Task reference", - "type": "string", - "pattern": "^\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - } - ] - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "operation" - }, - "canvasName": { - "not": { - "const": "childJob" - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "canvasName": { - "const": "childJob" - }, - "loop": { - "type": "object", - "properties": { - "atLeastOneComplete": { - "type": "boolean" - }, - "finishedCount": { - "type": "number" - }, - "isFinished": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^[0-9a-fA-F]{24}$": { - "type": "boolean" - } - } - }, - "outgoing": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "childJobLoopIndex": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "value": { - "type": "integer" - } - } - }, - "_id": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "_id": { - "type": "string" - } - } - }, - "initiator": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "_id": { - "type": "string" - } - } - } - } - }, - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - }, - "childJobs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "iteration": { - "type": "number" - } - } - } - } - } - } - ] - } - ] - }, - { - "type": "object", - "properties": { - "actor": { - "oneOf": [ - { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - { - "const": "job" - } - ] - }, - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - } - } - }, - "parent": { - "type": "object", - "properties": { - "job": { - "oneOf": [ - { - "type": "string", - "examples": ["fe7043ac41d24206aa556c49"] - }, - { - "type": "object", - "description": "A single job-api object without a parent.job of type object" - } - ] - }, - "task": { - "type": "string", - "examples": ["defc"] - }, - "iteration": { - "type": "number", - "examples": [1] - }, - "element": { - "type": "number", - "examples": [0] - } - } - }, - "errorHandler": { - "oneOf": [ - { - "type": "null" - }, - { - "allOf": [ - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "const": "pending" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "view": { - "type": "string" - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "automatic" - }, - "actor": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "const": "job" - }, - { - "$comment": "Job variable", - "type": "string", - "pattern": "^\\$var\\.job\\.[a-zA-Z_0-9]{1,}$" - }, - { - "$comment": "Task reference", - "type": "string", - "pattern": "^\\$var\\.[0-9a-f]{1,4}\\.[a-zA-Z_0-9]{1,}$" - } - ] - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "const": "operation" - }, - "canvasName": { - "not": { - "const": "childJob" - } - } - } - } - ] - }, - { - "allOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "x": { - "type": "number", - "description": "Stores the x coordinate used by canvasType = 1 workflows" - }, - "y": { - "type": "number", - "description": "Stores the y coordinate used by canvasType = 1 workflows" - }, - "gridCoordinate": { - "type": "object", - "description": "Stores the coordinates used by canvasType = 2 workflows", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - } - } - }, - { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "enum": [ - "Adapter", - "Application", - "Broker" - ] - }, - "locationType": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "app": { - "type": "string" - }, - "canvasName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": false, - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "error": { - "type": "string", - "pattern": "" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "deprecated": { - "type": "boolean" - }, - "scheduled": { - "type": "boolean" - }, - "matched": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "highlightString": { - "type": "string" - } - } - } - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "previous": { - "type": "object", - "properties": { - "incomplete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "complete": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - }, - "error": { - "type": "array", - "items": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - } - } - } - }, - "taskId": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "transitions": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "failure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - }, - "error": { - "type": "array", - "items": { - "type": "object", - "properties": { - "task": { - "oneOf": [ - { - "enum": [ - "workflow_start", - "workflow_end", - "error_handler" - ] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": [ - "workflow_start", - "e28f", - "3a1f" - ] - } - ] - }, - "type": { - "enum": [ - "standard", - "revert", - "loop" - ] - } - } - } - } - } - }, - "serverId": { - "type": "string" - }, - "start_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number" - }, - "finish_state": { - "enum": ["success", "failure", "error"] - }, - "retrySettings": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "properties": { - "state": { - "type": "array", - "items": { - "enum": [ - "success", - "error", - "failure" - ] - } - }, - "autoRetry": { - "type": "boolean" - }, - "limit": { - "type": "integer", - "minimum": 0 - }, - "delay": { - "type": "integer", - "minimum": 0 - }, - "count": { - "type": "integer", - "minimum": 0 - }, - "finishedRetrying": { - "type": "boolean" - } - }, - "additionalProperties": false - } - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "canvasName": { - "const": "childJob" - }, - "loop": { - "type": "object", - "properties": { - "atLeastOneComplete": { - "type": "boolean" - }, - "finishedCount": { - "type": "number" - }, - "isFinished": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^[0-9a-fA-F]{24}$": { - "type": "boolean" - } - } - }, - "outgoing": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "childJobLoopIndex": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "value": { - "type": "integer" - } - } - }, - "_id": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "_id": { - "type": "string" - } - } - }, - "initiator": { - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "_id": { - "type": "string" - } - } - } - } - }, - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - }, - "childJobs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "iteration": { - "type": "number" - } - } - } - } - } - } - ] - } - ] - }, - { - "type": "object", - "properties": { - "actor": { - "oneOf": [ - { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - { - "const": "job" - } - ] - }, - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "iterations": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "type": "object" - } - ] - } - } - } - } - ] - } - ] - }, - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "const": "default" - } - ] - } - }, - "watchers": { - "type": "array", - "items": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - } - }, - "metrics": { - "allOf": [ - { - "type": "object", - "properties": { - "start_time": { - "type": "number" - }, - "progress": { - "type": "number", - "minimum": 0, - "maximum": 1 - }, - "end_time": { - "type": "number" - } - } - }, - { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - }, - "owner": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - "output": { - "type": "object" - }, - "outputData": { - "type": "object" - } - } - } - ] - }, - "operations-manager_job-common_taskId": { - "oneOf": [ - { - "enum": ["workflow_start", "workflow_end", "error_handler"] - }, - { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["workflow_start", "e28f", "3a1f"] - } - ] - }, - "operations-manager_task-api": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Task Document", - "description": "A Task document in API response format.", - "$comment": "No required fields, because projection operators can result in any combination of fields", - "required": [], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "_id", - "location", - "view", - "status", - "app", - "name", - "variables", - "last_updated", - "encodingVersion", - "job", - "incomingRefs" - ] - }, - { - "enum": ["groups", "type", "metrics", "incomingRefs"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A UUIDv4 identifier.", - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - "location": { - "enum": ["Adapter", "Application", "Broker"] - }, - "view": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["/workflow_engine/task/ViewData"] - } - ] - }, - "status": { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - }, - "app": { - "type": "string", - "examples": ["WorkFlowEngine"] - }, - "name": { - "type": "string", - "examples": ["ViewData", "Stub", "Eval"] - }, - "variables": { - "type": "object", - "properties": { - "incoming": { - "type": "object" - }, - "outgoing": { - "type": "object" - }, - "decorators": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "const": "encryption" - }, - "pointer": { - "type": "string", - "format": "json-pointer" - } - } - } - } - } - }, - "last_updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "encodingVersion": { - "enum": [1] - }, - "job": { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "task": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["e28f", "3a1f", "b4f"] - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["View Task Data"] - } - ] - }, - "ancestors": { - "oneOf": [ - { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "type": "null" - } - ] - } - } - }, - "incomingRefs": { - "type": "array" - } - } - }, - { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "name": { - "type": "string", - "examples": ["admin"] - }, - "description": { - "type": "string" - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": ["66ec91e12b18975149d9e0d9"] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "metrics": { - "allOf": [ - { - "type": "object", - "properties": { - "start_time": { - "type": "string", - "example": ["2025-03-11T19:03:31.515Z"] - }, - "claim_time": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end_time": { - "type": "number", - "examples": [1740438512495] - }, - "server_id": { - "type": "string", - "examples": [ - "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" - ] - }, - "finish_state": { - "oneOf": [ - { - "const": "success" - }, - { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - } - ] - }, - "run_time": { - "type": "number", - "examples": [5] - } - } - }, - { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - }, - "owner": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "operation" - }, - "metrics": { - "allOf": [ - { - "type": "object", - "properties": { - "start_time": { - "type": "string", - "example": ["2024-03-11T19:03:31.515Z"] - }, - "end_time": { - "type": "number", - "example": [1740438512495] - }, - "server_id": { - "type": "string", - "examples": [ - "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" - ] - }, - "finish_state": { - "oneOf": [ - { - "const": "success" - }, - { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - } - ] - }, - "run_time": { - "type": "number", - "examples": [6] - }, - "retrying": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - }, - "owner": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "automatic" - }, - "metrics": { - "allOf": [ - { - "type": "object", - "properties": { - "start_time": { - "type": "string", - "example": ["2024-03-11T19:03:31.515Z"] - }, - "end_time": { - "type": "number", - "example": [1740438512495] - }, - "server_id": { - "type": "string", - "examples": [ - "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860" - ] - }, - "finish_state": { - "oneOf": [ - { - "const": "success" - }, - { - "enum": [ - "incomplete", - "scheduled", - "running", - "complete", - "canceled", - "error", - "failure", - "paused" - ] - } - ] - }, - "run_time": { - "type": "number", - "examples": [6] - }, - "retrying": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "user": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - }, - "owner": { - "oneOf": [ - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "provenance": { - "type": "string", - "examples": ["Local AAA"] - }, - "username": { - "type": "string", - "examples": ["admin@pronghorn"] - }, - "firstname": { - "type": "string", - "examples": ["admin"] - }, - "memberOf": { - "type": "array", - "items": { - "type": "object", - "properties": { - "groupId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "aaaManaged": { - "type": "boolean" - } - } - } - }, - "assignedRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "roleId": { - "type": "string", - "examples": [ - "66ec91e12b18975149d9e0d9" - ] - } - } - } - }, - "inactive": { - "type": "boolean" - }, - "lastLogin": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "_meta": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "updated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "email": { - "type": "string", - "examples": ["admin@itential.com"] - } - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "enum": ["", "Pronghorn"] - } - ] - } - } - } - ] - } - } - } - ] - } - ] - }, - "operations-manager_task-common_taskId": { - "type": "string", - "pattern": "^[0-9a-f]{1,4}$", - "examples": ["e28f", "3a1f", "b4f"] - }, - "operations-manager_trigger-api": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger", - "description": "An Endpoint Trigger in API response format.", - "required": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "lastExecuted", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "verb", - "routeName", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger", - "description": "An EventSystem Trigger in API response format.", - "required": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "lastExecuted", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "source", - "topic", - "schema", - "legacyWrapper", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["source", "topic", "schema", "legacyWrapper"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger", - "description": "A Manual Trigger in API response format.", - "required": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "lastExecuted", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "formData", - "legacyWrapper", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["formData", "formSchemaHash", "legacyWrapper"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Trigger", - "description": "A Schedule Trigger in API response format.", - "required": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "lastExecuted", - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated", - "formData", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "processMissedRuns", - "locked", - "repeatUnit", - "repeatFrequency", - "repeatInterval", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": ["repeating", "terminating"] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - }, - "operations-manager_trigger-common_commonFields": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - "operations-manager_trigger-create": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger Create", - "description": "The format of accepted input for the creation of an Endpoint Trigger.", - "required": ["name", "type", "routeName"], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger Create", - "description": "The format of accepted input for the creation of an EventSystem Trigger.", - "required": ["name", "type", "topic"], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["source", "topic", "schema", "legacyWrapper"] - }, - { - "enum": ["jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger Create", - "description": "The format of accepted input for the creation of a Manual Trigger.", - "required": ["name", "type"], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["formData", "formSchemaHash", "legacyWrapper"] - }, - { - "enum": ["formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Trigger Create", - "description": "The format of accepted input for the creation of a Schedule Trigger.", - "required": ["name", "type", "processMissedRuns"], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["formId"] - } - ] - }, - "oneOf": [ - { - "required": ["repeatUnit", "repeatFrequency"] - }, - { - "not": { - "required": ["repeatUnit", "repeatFrequency"] - } - } - ], - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "const": "Pronghorn" - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": ["repeating", "terminating"] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - }, - "operations-manager_trigger-json": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger", - "description": "An Endpoint Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "verb", - "routeName", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger", - "description": "An EventSystem Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "source", - "topic", - "schema", - "_id", - "jst" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["source", "topic", "schema", "legacyWrapper"] - }, - { - "enum": ["_id", "jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "jst": { - "oneOf": [ - { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger", - "description": "A Manual Trigger in JSON/export format.", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "formData", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["formData", "formSchemaHash", "legacyWrapper"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Triggers Schema for JSON Representation", - "description": "Schema for a Schedule Trigger JSON representation", - "required": [ - "name", - "type", - "enabled", - "actionType", - "actionId", - "formData", - "firstRunAt", - "processMissedRuns", - "repeatUnit", - "repeatFrequency", - "repeatInterval", - "_id", - "formId" - ], - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["_id", "formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "string", - "examples": ["admin@pronghorn"] - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": ["repeating", "terminating"] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "formId": { - "description": "The name or id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - }, - "operations-manager_trigger-update": { - "$schema": "http://json-schema.org/draft-07/schema", - "oneOf": [ - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Endpoint Trigger Updates", - "description": "The format of accepted input for an update operation on an Endpoint Trigger.", - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": ["verb", "routeName", "schema"] - }, - { - "enum": ["jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "endpoint" - }, - "verb": { - "const": "POST" - }, - "routeName": { - "description": "User defined route name.", - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$", - "examples": [ - "runSoftwareUpgrade", - "runInfoBloxCreateARecord" - ] - }, - "schema": { - "description": "POST body filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "object", - "properties": { - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "EventSystem Trigger Updates", - "description": "The format of accepted input for an update operation on an EventSystem Trigger.", - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": ["source", "topic", "schema", "legacyWrapper"] - }, - { - "enum": ["jst"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "eventSystem" - }, - "source": { - "description": "The source of the event.", - "type": "string", - "examples": ["@itential/app-operations_manager"] - }, - "topic": { - "description": "The event topic.", - "type": "string", - "examples": ["missedJobs"] - }, - "schema": { - "description": "Event payload filter schema.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether payload data is wrapped in a 'payload' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "jst": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Manual Trigger Updates", - "description": "The format of accepted input for an update operation on a Manual Trigger.", - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": ["formData", "formSchemaHash", "legacyWrapper"] - }, - { - "enum": ["formId"] - } - ] - }, - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "manual" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - }, - { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Schedule Trigger Updates", - "description": "The format of accepted input for an update operation on a Schedule Trigger.", - "propertyNames": { - "anyOf": [ - { - "enum": [ - "name", - "description", - "type", - "enabled", - "actionType", - "actionId", - "options", - "lastExecuted", - "migrationVersion" - ] - }, - { - "enum": [ - "formData", - "formSchemaHash", - "legacyWrapper", - "firstRunAt", - "nextRunAt", - "stopRunningAt", - "lastIntervalStart", - "processMissedRuns", - "locked", - "waitFlag", - "repeat" - ] - }, - { - "enum": ["repeatUnit", "repeatFrequency"] - }, - { - "enum": ["repeatInterval"] - }, - { - "enum": ["formId"] - } - ] - }, - "oneOf": [ - { - "required": ["repeatUnit", "repeatFrequency"] - }, - { - "not": { - "required": ["repeatUnit", "repeatFrequency"] - } - } - ], - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": [ - "Cisco IOS upgrade", - "Port Turn UP - IOS - IAG", - "Consume Message Kafka-V2" - ], - "not": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": [ - "Turn up the port", - "Consume message from Topic", - "Run software upgrade on Cisco routers running IOS XR software" - ] - }, - "enabled": { - "type": "boolean", - "description": "A flag to determine if this Trigger is enabled or not." - }, - "actionType": { - "type": "string", - "description": "The type of component this Trigger will invoke.", - "enum": ["automations"] - }, - "actionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "options": { - "type": "object", - "description": "Configuration options specific to this trigger.", - "properties": { - "targetType": { - "oneOf": [ - { - "enum": ["instance", "group"] - }, - { - "type": "null" - } - ] - }, - "targetIdentifier": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - }, - "chooseTargetAtRuntime": { - "type": "boolean" - }, - "actionId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - }, - "lastExecuted": { - "description": "A timestamp in milliseconds of the time this Trigger was last executed.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "migrationVersion": { - "description": "The current document version of this document.", - "type": "integer", - "examples": [1, 2, 3] - } - } - }, - { - "type": "object", - "properties": { - "type": { - "const": "schedule" - }, - "formData": { - "description": "A JSON object created by filling out the associated JSON Form.", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "examples": [ - { - "deviceName": "ATL-123", - "action": "SYNC" - }, - { - "ip": "1.2.3.4", - "name": "Cisco IOS XR" - } - ] - }, - "formSchemaHash": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "legacyWrapper": { - "description": "A boolean determining whether form data is wrapped in a 'formData' property", - "type": "boolean" - }, - "firstRunAt": { - "description": "A timestamp in milliseconds for the first scheduled run of this Trigger.", - "type": "integer", - "minimum": 0 - }, - "nextRunAt": { - "description": "A timestamp in milliseconds for the next scheduled run of this Trigger.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "example": 1648829216268 - }, - "stopRunningAt": { - "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "lastIntervalStart": { - "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - }, - "processMissedRuns": { - "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", - "type": "string", - "enum": ["none", "last"] - }, - "locked": { - "description": "backend use only", - "type": "boolean" - }, - "waitFlag": { - "description": "Deprecated, backend use only", - "type": "boolean" - }, - "repeat": { - "description": "A repetition pattern expressed as a tree of parent and child interval definitions.", - "oneOf": [ - { - "type": "null" - }, - { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "enum": ["repeating", "terminating"] - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "date-range" - }, - "start": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "end": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "type": { - "const": "count" - }, - "duration": { - "oneOf": [ - { - "type": "object", - "properties": { - "unit": { - "const": "second" - }, - "quantity": { - "type": "number", - "minimum": 0, - "multipleOf": 10, - "examples": [30, 140, 2000] - } - } - }, - { - "type": "object", - "properties": { - "unit": { - "enum": [ - "minute", - "hour", - "day", - "week" - ] - }, - "quantity": { - "type": "number", - "minimum": 0, - "examples": [1, 3, 5, 10] - } - } - }, - { - "$comment": "Implicit unit of milliseconds", - "type": "number", - "minimum": 0, - "multipleOf": 10000, - "examples": [10000, 30000, 100000] - } - ] - }, - "count": { - "type": "integer", - "minimum": 0, - "examples": [2, 5, 10, 25] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "action": { - "enum": ["execute", "wait"] - } - }, - "required": ["action"] - }, - { - "type": "object", - "properties": { - "components": { - "type": "array", - "items": {} - } - }, - "required": ["components"] - } - ] - } - ] - } - ] - } - ] - } - } - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "null" - }, - "repeatFrequency": { - "type": "null" - } - } - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "type": "string", - "enum": ["minute", "hour", "day", "week"] - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit"] - }, - { - "type": "object", - "properties": { - "repeatUnit": { - "const": "second" - }, - "repeatFrequency": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "multipleOf": 10 - }, - { - "type": "null" - } - ] - } - }, - "required": ["repeatUnit", "repeatFrequency"] - } - ] - }, - { - "type": "object", - "properties": { - "repeatInterval": { - "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "examples": [10000, 30000, 120000] - } - } - }, - { - "type": "object", - "properties": { - "formId": { - "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from #/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "null" - } - ] - } - } - } - ] - } - ] - }, - "mop_mopAnalyticTemplateDoc": { - "title": "mop analytic template", - "description": "A mop analytic template object", - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ] - }, - "os": { - "type": "string", - "examples": ["cisco-ios"] - }, - "passRule": { - "type": "boolean" - }, - "prepostCommands": { - "type": "array", - "items": { - "type": "object", - "properties": { - "preRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "postRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "passRule": { - "type": "boolean" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["regex"] - }, - "preRegex": { - "type": "string", - "examples": [""] - }, - "postRegex": { - "type": "string", - "examples": [""] - }, - "evaluation": { - "type": "string", - "examples": ["="] - } - } - } - }, - "preCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - }, - "postCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - } - } - } - }, - "created": { - "type": "integer", - "examples": [1508182880981] - }, - "createdBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - }, - "lastUpdated": { - "type": "integer", - "examples": [1508182880981] - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - } - }, - "required": ["name"] - }, - "mop_mopAnalyticTemplateDoc__id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "mop_mopAnalyticTemplateDoc_name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "mop_mopAnalyticTemplateDoc_successResponse": { - "type": "object", - "properties": { - "result": { - "type": "object", - "properties": { - "n": { - "type": "integer", - "examples": [1] - }, - "ok": { - "type": "integer", - "examples": [1] - } - } - }, - "ops": { - "type": "array", - "items": { - "title": "mop analytic template", - "description": "A mop analytic template object", - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ] - }, - "os": { - "type": "string", - "examples": ["cisco-ios"] - }, - "passRule": { - "type": "boolean" - }, - "prepostCommands": { - "type": "array", - "items": { - "type": "object", - "properties": { - "preRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "postRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "passRule": { - "type": "boolean" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["regex"] - }, - "preRegex": { - "type": "string", - "examples": [""] - }, - "postRegex": { - "type": "string", - "examples": [""] - }, - "evaluation": { - "type": "string", - "examples": ["="] - } - } - } - }, - "preCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - }, - "postCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - } - } - } - }, - "created": { - "type": "integer", - "examples": [1508182880981] - }, - "createdBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - }, - "lastUpdated": { - "type": "integer", - "examples": [1508182880981] - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - } - }, - "required": ["name"], - "definitions": { - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "projectNamespace": { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "_id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "prepostCommand": { - "type": "object", - "properties": { - "preRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "postRawCommand": { - "type": "string", - "examples": ["show running-config ip prefix-list"] - }, - "passRule": { - "type": "boolean" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "examples": ["regex"] - }, - "preRegex": { - "type": "string", - "examples": [""] - }, - "postRegex": { - "type": "string", - "examples": [""] - }, - "evaluation": { - "type": "string", - "examples": ["="] - } - } - } - }, - "preCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - }, - "postCommandResHTML": { - "type": "string", - "examples": [ - "Test a command or the template to get results here" - ] - } - } - }, - "successResponse": { - "type": "object", - "properties": { - "result": { - "type": "object", - "properties": { - "n": { - "type": "integer", - "examples": [1] - }, - "ok": { - "type": "integer", - "examples": [1] - } - } - }, - "ops": { - "type": "array", - "items": {} - }, - "insertedCount": { - "type": "integer", - "examples": [1] - }, - "insertedIds": { - "type": "object", - "properties": { - "0": { - "type": "string", - "examples": ["TestAnalysisTemp"] - } - } - } - } - } - } - } - }, - "insertedCount": { - "type": "integer", - "examples": [1] - }, - "insertedIds": { - "type": "object", - "properties": { - "0": { - "type": "string", - "examples": ["TestAnalysisTemp"] - } - } - } - } - }, - "mop_mopTemplateDoc": { - "title": "mop template", - "description": "A mop template object", - "type": "object", - "properties": { - "_id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "namespace": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "object", - "required": [], - "properties": { - "type": { - "const": "project" - }, - "_id": { - "type": "string", - "examples": ["5cb5252a1bbc5a00def564c1"] - }, - "name": { - "type": "string" - }, - "accessControl": { - "type": "object", - "properties": { - "read": { - "type": "array", - "items": { - "type": "string" - } - }, - "execute": { - "type": "array", - "items": { - "type": "string" - } - }, - "write": { - "type": "array", - "items": { - "type": "string" - } - }, - "manage": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ] - }, - "os": { - "type": "string", - "examples": ["cisco-ios"] - }, - "passRule": { - "type": "boolean" - }, - "commands": { - "type": "array", - "items": { - "type": "object", - "properties": { - "command": { - "type": "string", - "examples": ["show running-config ip vrf"] - }, - "passRule": { - "type": "boolean" - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "rule": { - "type": "string", - "examples": ["show version"] - }, - "eval": { - "type": "string", - "examples": ["contains"] - }, - "raw": { - "type": "string", - "examples": ["show version"] - }, - "result": { - "type": "boolean" - } - }, - "required": ["rule", "eval"] - } - } - } - } - }, - "created": { - "type": "integer", - "examples": [1508182880981] - }, - "createdBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - }, - "lastUpdated": { - "type": "integer", - "examples": [1508182880981] - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "string", - "examples": ["exampleUser"] - } - ] - } - }, - "required": ["name"] - }, - "mop_mopTemplateDoc__id": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "mop_mopTemplateDoc_name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "mop_mopTemplateDoc_successResponse": { - "type": "object", - "properties": { - "n": { - "type": "integer", - "examples": [1] - }, - "ok": { - "type": "integer", - "examples": [1] - }, - "nModified": { - "type": "integer", - "examples": [1] - } - } - }, - "mop_mopTemplateDoc_variables": { - "type": "object", - "properties": {}, - "examples": [ - { - "device_name": "my-device1" - } - ] - }, - "mop_mopTemplateDoc_devices": { - "type": "array", - "items": { - "type": "string", - "examples": ["Device 2", "Device 1"] - } - }, - "mop_mopTemplateDoc_runCommandRes": { - "type": "object", - "properties": { - "raw": { - "type": "string", - "examples": ["show version"] - }, - "all_pass_flag": { - "type": "boolean" - }, - "evaluated": { - "type": "string", - "examples": ["show version"] - }, - "parameters": { - "type": "object", - "properties": {} - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "rule": { - "type": "string", - "examples": ["show version"] - }, - "eval": { - "type": "string", - "examples": ["contains"] - }, - "raw": { - "type": "string", - "examples": ["show version"] - }, - "result": { - "type": "boolean" - } - }, - "required": ["rule", "eval"] - } - }, - "device": { - "type": "string", - "examples": ["device1"] - }, - "response": { - "type": "string", - "examples": ["version: 10.0.0"] - }, - "result": { - "type": "boolean" - } - } - }, - "mop_mopTemplateDoc_device": { - "type": "string", - "examples": ["device1"] - }, - "mop_mopTemplateDoc_options": { - "type": "object", - "properties": { - "start": { - "type": "integer", - "examples": [0] - }, - "limit": { - "type": "integer", - "examples": [25] - }, - "entity": { - "type": "string", - "examples": ["device1"] - }, - "filter": { - "type": "string", - "examples": ["filter"] - }, - "sort": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "integer", - "examples": [1] - } - } - } - } - } - }, - "mop_mopTemplateDoc_detailedDevice": { - "type": "object", - "properties": { - "name": { - "type": "string", - "examples": ["ASR1K-MOP"] - }, - "authgroup": { - "type": "string", - "examples": ["csr-aws", "default"] - }, - "address": { - "type": "string", - "examples": ["127.0.0.1"] - }, - "port": { - "type": "string", - "examples": ["12035"] - }, - "device-type": { - "type": "string", - "examples": ["netconf"] - }, - "ned": { - "type": "string", - "examples": ["nso46"] - }, - "admin": { - "type": "boolean" - }, - "host": { - "type": "string", - "examples": ["Local Host"] - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "examples": ["Group1"] - } - } - } - }, - "lifecycle-manager_common-http_document-identifier": { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - }, - "lifecycle-manager_common-http_pagination-metadata": { - "description": "Properties describing search result pagination", - "type": "object", - "properties": { - "skip": { - "type": "integer" - }, - "limit": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "nextPageSkip": { - "type": "integer" - }, - "previousPageSkip": { - "type": "integer" - }, - "currentPageSize": { - "type": "integer" - } - } - }, - "lifecycle-manager_common-http_response": { - "oneOf": [ - { - "description": "A success response from an API method", - "type": "object", - "additionalProperties": false, - "required": ["message", "data", "metadata"], - "properties": { - "message": { - "description": "A human-readable message summarizing the result of the operation", - "type": "string", - "examples": [ - "Successfully created the requested item", - "Successfully imported 3 of 4 documents", - "Successfully retrieved search results" - ] - }, - "data": { - "const": "null", - "description": "Any successfully retrieved information related to the request." - }, - "metadata": { - "description": "Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.", - "type": "object", - "additionalProperties": true - } - } - }, - { - "description": "A failure response from an API method", - "type": "object", - "additionalProperties": false, - "required": ["message", "data", "metadata"], - "properties": { - "message": { - "description": "A human-readable message summarizing the result of the operation", - "type": "string", - "examples": [ - "A server error occurred while processing this request" - ] - }, - "data": { - "const": "null", - "description": "Any successfully retrieved information related to the request. For error responses, this is always 'null'." - }, - "metadata": { - "description": "Any structured, wordy or machine-readable information related to the result of the operation. For error responses, this will always at least contain an 'errors' array, even if it is empty.", - "type": "object", - "properties": { - "errors": { - "type": "array" - } - }, - "additionalProperties": true - } - } - } - ] - }, - "lifecycle-manager_common_name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "lifecycle-manager_common_ObjectIdLikeString": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "lifecycle-manager_common_ObjectId": { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - }, - "lifecycle-manager_instance-group-create": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Resource Instance Group Create", - "description": "The format of accepted input for the creation of a Resource Instance Group document.", - "type": "object", - "allOf": [ - { - "propertyNames": { - "enum": [ - "name", - "description", - "modelId", - "type", - "lastAction", - "instances", - "filter" - ] - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": ["Some helpful information about the document"] - }, - "modelId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "oneOf": [ - { - "type": "object", - "not": { - "required": ["filter"] - }, - "properties": { - "type": { - "const": "manual" - }, - "instances": { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "type": "object", - "not": { - "required": ["instances"] - }, - "properties": { - "type": { - "const": "dynamic" - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "lastAction": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - }, - "created": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "updated": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - } - } - } - } - } - ] - } - ] - }, - { - "required": ["name", "modelId"] - } - ] - }, - "lifecycle-manager_instance-group-http": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Resource Instance Group Document", - "description": "A Resource Instance Group document in HTTP response format.", - "type": "object", - "allOf": [ - { - "propertyNames": { - "anyOf": [ - { - "enum": [ - "createdBy", - "created", - "lastUpdatedBy", - "lastUpdated" - ] - }, - { - "enum": ["_id"] - }, - { - "enum": [ - "name", - "description", - "modelId", - "type", - "lastAction", - "instances", - "filter" - ] - } - ] - } - }, - { - "type": "object", - "required": ["createdBy", "created", "lastUpdatedBy", "lastUpdated"] - }, - { - "type": "object", - "properties": { - "createdBy": { - "oneOf": [ - { - "type": "object", - "properties": { - "firstname": { - "type": "string" - }, - "provenance": { - "type": "string" - }, - "username": { - "type": "string" - }, - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "type": "null" - } - ] - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "oneOf": [ - { - "type": "object", - "properties": { - "firstname": { - "type": "string" - }, - "provenance": { - "type": "string" - }, - "username": { - "type": "string" - }, - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "type": "null" - } - ] - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - { - "type": "object", - "required": ["_id"] - }, - { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "allOf": [ - { - "type": "object", - "required": [ - "name", - "description", - "modelId", - "type", - "lastAction" - ] - }, - { - "oneOf": [ - { - "type": "object", - "required": ["instances"] - }, - { - "type": "object", - "required": ["filter"] - } - ] - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": ["Some helpful information about the document"] - }, - "modelId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "oneOf": [ - { - "type": "object", - "not": { - "required": ["filter"] - }, - "properties": { - "type": { - "const": "manual" - }, - "instances": { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "type": "object", - "not": { - "required": ["instances"] - }, - "properties": { - "type": { - "const": "dynamic" - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "lastAction": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - }, - "created": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "updated": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - } - } - } - } - } - ] - } - ] - }, - { - "type": "object", - "properties": { - "lastAction": { - "description": "The last action that was run against this document", - "type": "object", - "additionalProperties": false, - "required": ["_id", "executionId", "name", "type", "status"], - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "executionId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": [ - "running", - "error", - "complete", - "canceled", - "paused" - ] - } - } - } - } - } - ] - }, - "lifecycle-manager_instance-group-search-params": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Resource Instance Group Search Parameters", - "description": "Search Parameters supported on the Resource Instance Group collection.", - "type": "object", - "allOf": [ - { - "type": "object", - "properties": { - "skip": { - "description": "This parameter specifies where to start the returned page of search results.", - "type": "string" - }, - "limit": { - "description": "This parameter specifies how many items to return in the search results.", - "type": "string" - } - } - }, - { - "type": "object", - "properties": { - "sort": { - "description": "This parameter specifies the field to sort the search results over.", - "type": "string", - "examples": ["name", "created"] - }, - "order": { - "description": "This parameter specifies the direction to sort the search results over.", - "enum": ["asc", "desc"] - } - } - }, - { - "properties": { - "equals": { - "type": "object", - "properties": { - "modelName": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "type": { - "enum": ["manual", "dynamic"] - }, - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "modelId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "createdBy": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdatedBy": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - "in": { - "allOf": [ - { - "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", - "type": "object", - "examples": [ - { - "stateId": "1234,53fe,0000" - }, - { - "name": "name1,name2,name3" - } - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "array", - "items": { - "enum": ["manual", "dynamic"] - } - }, - "lastAction": { - "type": "object", - "properties": { - "type": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - } - } - } - } - } - ] - }, - "starts-with": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - } - } - }, - "lt": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "lte": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "gt": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "gte": { - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "lastUpdated": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "dereference": { - "description": "Comma-separated list of foreign key field types to dereference", - "const": "accounts" - } - } - } - ] - }, - "lifecycle-manager_instance-group-update": { - "$schema": "http://json-schema.org/draft-07/schema", - "title": "Resource Instance Group Update", - "description": "The format of accepted input for updating a Resource Instance Group document.", - "type": "object", - "allOf": [ - { - "propertyNames": { - "allOf": [ - { - "enum": [ - "name", - "description", - "modelId", - "type", - "lastAction", - "instances", - "filter" - ] - }, - { - "enum": ["instancesToAdd", "instancesToRemove"] - } - ] - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "description": { - "type": "string", - "description": "The description of the document", - "examples": ["Some helpful information about the document"] - }, - "modelId": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - }, - { - "oneOf": [ - { - "type": "object", - "not": { - "required": ["filter"] - }, - "properties": { - "type": { - "const": "manual" - }, - "instances": { - "type": "array", - "items": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - } - } - }, - { - "type": "object", - "not": { - "required": ["instances"] - }, - "properties": { - "type": { - "const": "dynamic" - }, - "filter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "lastAction": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - }, - "created": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - }, - "updated": { - "type": "object", - "properties": { - "before": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "after": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - } - } - } - } - } - } - } - ] - } - ] - }, - { - "properties": { - "instancesToAdd": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - } - ] - } - }, - "instancesToRemove": { - "type": "array", - "items": { - "oneOf": [ - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - } - ] - } - } - } - } - ] - }, - "lifecycle-manager_resource-action-execution-http": { - "oneOf": [ - { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "modelId", - "modelName", - "instanceId", - "instanceName", - "actionId", - "actionName", - "jobId", - "startTime", - "endTime", - "progress", - "status", - "errors", - "initiator", - "initiatorName", - "initialInstanceData", - "finalInstanceData" - ], - "properties": { - "_id": {}, - "modelId": {}, - "modelName": { - "description": "The name of the model as it was when the action was run", - "type": "string" - }, - "executionType": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - }, - "instanceId": {}, - "instanceName": { - "description": "The name of the instance as it was when the action was run", - "type": "string" - }, - "actionId": { - "description": "Identifier of the action that was run" - }, - "actionName": { - "description": "The name of the action as it was when the action was run", - "type": "string" - }, - "actionType": { - "description": "The type of the action" - }, - "jobId": { - "description": "Identifier of the job associated with the action", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "progress": { - "description": "A sequence of key points in the action describing its overall progress", - "type": "object", - "patternProperties": { - ".*": { - "description": "A record indicating a progress point in the flow of the action", - "type": "object", - "additionalProperties": false, - "required": [ - "progressType", - "status", - "error", - "_id", - "componentName", - "componentId" - ], - "properties": { - "_id": { - "description": "Uniquely identifies the progress point within the overall sequence", - "type": "string" - }, - "componentId": { - "description": "The id of the component related to the step", - "type": "string" - }, - "componentName": { - "description": "The name of the component related to the step", - "type": "string" - }, - "progressType": { - "description": "Designates what type of progress point this object describes", - "const": "resource:action" - }, - "error": { - "description": "Records any errors directly related to the components in the progress item", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "status": { - "description": "Designates the status of the progress item", - "type": "string", - "enum": ["pending", "complete", "error"] - } - } - } - } - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": ["running", "error", "complete", "canceled", "paused"] - }, - "errors": { - "description": "A list of any errors which occurred while the action was running", - "type": "array", - "items": { - "description": "A record of an error which occurred while the action was running", - "type": "object", - "properties": { - "message": { - "description": "A human-readable message summarizing the issue", - "type": "string" - }, - "origin": { - "description": "Designates where the error came from", - "type": "string", - "enum": [ - "preTransformation", - "workflow", - "postTransformation", - "finishAction", - "system" - ] - }, - "timestamp": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "metadata": { - "description": "Additional properties that help describe the issue" - }, - "stepId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - } - }, - "initiator": {}, - "initiatorName": { - "description": "The name of the user or automation trigger that initiated the action", - "type": "string" - }, - "initialInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - }, - "finalInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - } - }, - { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "modelId", - "modelName", - "instanceId", - "instanceName", - "actionId", - "actionName", - "parentActionExecutionId", - "jobId", - "startTime", - "endTime", - "progress", - "status", - "errors", - "initiator", - "initiatorName", - "initialInstanceData", - "finalInstanceData" - ], - "properties": { - "_id": {}, - "modelId": {}, - "modelName": { - "description": "The name of the model as it was when the action was run", - "type": "string" - }, - "executionType": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - }, - "instanceId": {}, - "instanceName": { - "description": "The name of the instance as it was when the action was run", - "type": "string" - }, - "actionId": { - "description": "Identifier of the action that was run" - }, - "actionName": { - "description": "The name of the action as it was when the action was run", - "type": "string" - }, - "actionType": { - "description": "The type of the action" - }, - "parentActionExecutionId": { - "description": "Identifier of the job associated with the action" - }, - "groupId": { - "description": "Identifier of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "groupName": { - "description": "The name of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "jobId": { - "description": "Identifier of the job associated with the action", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "progress": { - "description": "A sequence of key points in the action describing its overall progress", - "type": "object", - "patternProperties": { - ".*": { - "description": "A record indicating a progress point in the flow of the action", - "type": "object", - "additionalProperties": false, - "required": [ - "progressType", - "status", - "error", - "_id", - "componentName", - "componentId" - ], - "properties": { - "_id": { - "description": "Uniquely identifies the progress point within the overall sequence", - "type": "string" - }, - "componentId": { - "description": "The id of the component related to the step", - "type": "string" - }, - "componentName": { - "description": "The name of the component related to the step", - "type": "string" - }, - "progressType": { - "description": "Designates what type of progress point this object describes", - "const": "resource:action" - }, - "error": { - "description": "Records any errors directly related to the components in the progress item", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "status": { - "description": "Designates the status of the progress item", - "type": "string", - "enum": ["pending", "complete", "error"] - } - } - } - } - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": ["running", "error", "complete", "canceled", "paused"] - }, - "errors": { - "description": "A list of any errors which occurred while the action was running", - "type": "array", - "items": { - "description": "A record of an error which occurred while the action was running", - "type": "object", - "properties": { - "message": { - "description": "A human-readable message summarizing the issue", - "type": "string" - }, - "origin": { - "description": "Designates where the error came from", - "type": "string", - "enum": [ - "preTransformation", - "workflow", - "postTransformation", - "finishAction", - "system" - ] - }, - "timestamp": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "metadata": { - "description": "Additional properties that help describe the issue" - }, - "stepId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - } - }, - "initiator": {}, - "initiatorName": { - "description": "The name of the user or automation trigger that initiated the action", - "type": "string" - }, - "initialInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - }, - "finalInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - } - }, - { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "modelId", - "modelName", - "instanceIds", - "childStatuses", - "actionId", - "actionName", - "jobId", - "startTime", - "endTime", - "progress", - "status", - "errors", - "initiator", - "initiatorName" - ], - "properties": { - "_id": {}, - "modelId": {}, - "modelName": { - "description": "The name of the model as it was when the action was run", - "type": "string" - }, - "executionType": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - }, - "instanceIds": { - "description": "The IDs of the instances that are being acted upon", - "type": "array", - "items": {} - }, - "childStatuses": { - "description": "An object mapping the current status of child action executions", - "type": "object" - }, - "actionId": { - "description": "Identifier of the action that was run" - }, - "actionName": { - "description": "The name of the action as it was when the action was run", - "type": "string" - }, - "actionType": { - "description": "The type of the action" - }, - "groupId": { - "description": "Identifier of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "groupName": { - "description": "The name of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "jobId": { - "description": "Identifier of the job associated with the action", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "progress": { - "description": "A sequence of key points in the action describing its overall progress", - "type": "object", - "patternProperties": { - ".*": { - "description": "A record indicating a progress point in the flow of the action", - "type": "object", - "additionalProperties": false, - "required": [ - "progressType", - "status", - "error", - "_id", - "componentName", - "componentId" - ], - "properties": { - "_id": { - "description": "Uniquely identifies the progress point within the overall sequence", - "type": "string" - }, - "componentId": { - "description": "The id of the component related to the step", - "type": "string" - }, - "componentName": { - "description": "The name of the component related to the step", - "type": "string" - }, - "progressType": { - "description": "Designates what type of progress point this object describes", - "const": "resource:action" - }, - "error": { - "description": "Records any errors directly related to the components in the progress item", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "status": { - "description": "Designates the status of the progress item", - "type": "string", - "enum": ["pending", "complete", "error"] - } - } - } - } - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": ["running", "error", "complete", "canceled", "paused"] - }, - "errors": { - "description": "A list of any errors which occurred while the action was running", - "type": "array", - "items": { - "description": "A record of an error which occurred while the action was running", - "type": "object", - "properties": { - "message": { - "description": "A human-readable message summarizing the issue", - "type": "string" - }, - "origin": { - "description": "Designates where the error came from", - "type": "string", - "enum": [ - "preTransformation", - "workflow", - "postTransformation", - "finishAction", - "system" - ] - }, - "timestamp": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "metadata": { - "description": "Additional properties that help describe the issue" - }, - "stepId": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - } - } - } - }, - "initiator": { - "oneOf": [ - { - "const": "Pronghorn" - }, - {} - ] - }, - "initiatorName": { - "type": "string" - }, - "initialInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - }, - "finalInstanceData": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - ] - } - } - } - ] - }, - "lifecycle-manager_resource-action-execution-search-params": { - "description": "Search parameters for resource action executions", - "type": "object", - "additionalProperties": false, - "required": [], - "allOf": [ - { - "type": "object", - "properties": { - "skip": { - "description": "This parameter specifies where to start the returned page of search results.", - "type": "string" - }, - "limit": { - "description": "This parameter specifies how many items to return in the search results.", - "type": "string" - } - } - }, - { - "type": "object", - "properties": { - "sort": { - "description": "This parameter specifies the field to sort the search results over.", - "type": "string", - "examples": ["name", "created"] - }, - "order": { - "description": "This parameter specifies the direction to sort the search results over.", - "enum": ["asc", "desc"] - } - } - }, - { - "type": "object", - "properties": { - "equals": { - "type": "object", - "properties": { - "_id": {}, - "modelId": {}, - "modelName": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "instanceId": {}, - "instanceName": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "groupId": {}, - "groupName": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - "actionId": { - "description": "The identifier of an action" - }, - "actionName": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "jobId": {}, - "executionType": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - }, - "startTime": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "endTime": { - "type": "string", - "description": "An ISO 8601 date string", - "format": "date-time" - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": [ - "running", - "error", - "complete", - "canceled", - "paused" - ] - }, - "initiator": {}, - "parentActionExecutionId": {} - } - }, - "in": { - "allOf": [ - { - "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", - "type": "object", - "examples": [ - { - "stateId": "1234,53fe,0000" - }, - { - "name": "name1,name2,name3" - } - ] - }, - { - "type": "object", - "properties": { - "modelId": { - "description": "A comma-delineated list of model ids to search for", - "type": "array", - "items": {} - }, - "gruopId": { - "description": "A comma-delineated list of group ids to search for", - "type": "array", - "items": {} - }, - "status": { - "description": "A comma-delineated list of statuses to search for", - "type": "array", - "items": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": [ - "running", - "error", - "complete", - "canceled", - "paused" - ] - } - }, - "executionType": { - "description": "A comma-delineated list of execution types to search for", - "type": "array", - "items": { - "description": "The type of execution action", - "type": "string", - "enum": ["individual", "parent", "child"] - } - } - } - } - ] - }, - "starts-with": { - "type": "object", - "properties": { - "modelName": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "groupName": { - "description": "The name of the group the bulk action was run against", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "instanceName": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "actionName": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "initiatorName": { - "type": "string" - } - } - }, - "lt": { - "type": "object", - "properties": { - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - } - } - }, - "lte": { - "type": "object", - "properties": { - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - } - } - }, - "gt": { - "type": "object", - "properties": { - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - } - } - }, - "gte": { - "type": "object", - "properties": { - "startTime": { - "description": "The time at which the action was started", - "type": "string", - "format": "date-time" - }, - "endTime": { - "description": "The time at which the action ended", - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - } - } - }, - "include": { - "type": "array", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - }, - "lifecycle-manager_resource-instance-common_name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "lifecycle-manager_resource-instance-common_description": { - "type": "string", - "description": "Free-form text describing the resource instance", - "default": "", - "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] - }, - "lifecycle-manager_resource-instance-export": { - "type": "object", - "additionalProperties": false, - "required": [ - "name", - "description", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy", - "instanceData" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource instance", - "default": "", - "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] - }, - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource instance" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource instance" - }, - "instanceData": { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - } - }, - "lifecycle-manager_resource-instance-http": { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "name", - "description", - "modelId", - "instanceData", - "lastAction", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource instance", - "default": "", - "examples": ["EC2 Instance in US-EAST-1 with ID ec2-12345678"] - }, - "modelId": {}, - "instanceData": { - "description": "The data for the resource instance", - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "lastAction": { - "description": "The last action that was run on this instance", - "type": "object", - "additionalProperties": false, - "required": ["_id", "executionId", "name", "type", "status"], - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "executionId": {}, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "status": { - "description": "A single string describing the current activity status of this action", - "type": "string", - "enum": ["running", "error", "complete", "canceled", "paused"] - } - } - }, - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource instance" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource instance" - }, - "instanceGroups": { - "description": "The groups that this resource instance is a member of", - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - } - } - } - } - } - }, - "lifecycle-manager_resource-instance-search-params": { - "type": "object", - "additionalProperties": false, - "required": [], - "allOf": [ - { - "type": "object", - "properties": { - "skip": { - "description": "This parameter specifies where to start the returned page of search results.", - "type": "string" - }, - "limit": { - "description": "This parameter specifies how many items to return in the search results.", - "type": "string" - } - } - }, - { - "type": "object", - "properties": { - "sort": { - "description": "This parameter specifies the field to sort the search results over.", - "type": "string", - "examples": ["name", "created"] - }, - "order": { - "description": "This parameter specifies the direction to sort the search results over.", - "enum": ["asc", "desc"] - } - } - }, - { - "properties": { - "equals": { - "type": "object", - "properties": { - "modelName": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "stateName": { - "description": "The name of the current state of the resource instance", - "type": "string" - }, - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - }, - "modelId": {}, - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "createdBy": {}, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - }, - "lastUpdatedBy": {} - } - }, - "in": { - "allOf": [ - { - "description": "This parameter specifies a comma-delimited list of values to search for in the given field(s).", - "type": "object", - "examples": [ - { - "stateId": "1234,53fe,0000" - }, - { - "name": "name1,name2,name3" - } - ] - }, - { - "type": "object", - "properties": { - "lastAction": { - "type": "object", - "properties": { - "type": { - "type": "array", - "items": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - } - } - } - } - } - } - ] - }, - "include-deleted": { - "type": "string", - "default": "false", - "enum": ["true", "false"] - }, - "starts-with": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the resource instance", - "examples": ["VLAN Service", "EC2 Instance"] - } - } - }, - "group": { - "type": "string", - "description": "An ID or name of an instance group to filter by", - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "The name of the document", - "examples": ["myCoolDocumentName"] - }, - { - "description": "A string which is formatted like an ObjectId, Distinct from an actual ObjectId.", - "$comment": "The pattern from common-db#/definitions/MongoDB_ObjectId is used to identify fields which are actual MongoDB ObjectIds.", - "type": "string", - "pattern": "^[0-9a-f]{24}$" - } - ] - }, - "instanceGroups": { - "type": "string", - "default": "false", - "enum": ["true", "false"] - }, - "lt": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - } - } - }, - "lte": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - } - } - }, - "gt": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - } - } - }, - "gte": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource instance was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource instance was last updated" - } - } - }, - "include": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "_id", - "name", - "description", - "modelId", - "instanceData", - "lastAction", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ] - } - }, - "exclude": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "_id", - "name", - "description", - "modelId", - "instanceData", - "lastAction", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ] - } - }, - "dereference": { - "description": "Comma-separated list of foreign key field types to dereference", - "const": "accounts" - } - } - } - ] - }, - "lifecycle-manager_resource-model-common_name": { - "type": "string", - "description": "The name of the resource model", - "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] - }, - "lifecycle-manager_resource-model-common_action-identifier": { - "description": "A 4-digit hexadecimal id", - "type": "string", - "pattern": "^[0-9a-fA-F]{4}$", - "examples": ["0a2f", "5341", "0000"] - }, - "lifecycle-manager_resource-model-common_action": { - "type": "object", - "required": [ - "_id", - "name", - "workflow", - "preWorkflowJst", - "postWorkflowJst", - "type" - ], - "additionalProperties": false, - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - }, - "lifecycle-manager_resource-model-common_actions": { - "type": "array", - "items": { - "type": "object", - "required": [ - "_id", - "name", - "workflow", - "preWorkflowJst", - "postWorkflowJst", - "type" - ], - "additionalProperties": false, - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - } - }, - "lifecycle-manager_resource-model-create-data": { - "type": "object", - "additionalProperties": false, - "required": ["name"], - "properties": { - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource model", - "default": "", - "examples": [ - "This resource model represents something we use on a day-to-day basis.", - "We use this to model one of the devices in our system.", - "This model tracks one of the elements of our cloud infrastructure." - ] - }, - "schema": { - "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "required": [ - "name", - "workflow", - "preWorkflowJst", - "postWorkflowJst", - "type" - ], - "additionalProperties": false, - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The _id of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "description": "The UUIDv4 identifying a workflow" - } - ] - } - } - } - } - } - }, - "lifecycle-manager_resource-model-export": { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "name", - "description", - "schema", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource model", - "default": "", - "examples": [ - "This resource model represents something we use on a day-to-day basis.", - "We use this to model one of the devices in our system.", - "This model tracks one of the elements of our cloud infrastructure." - ] - }, - "schema": { - "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - } - }, - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource model" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource model" - } - } - }, - "lifecycle-manager_resource-model-http": { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "name", - "description", - "schema", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": ["VLAN Service", "EC2 Instance", "ServiceNow Ticket"] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource model", - "default": "", - "examples": [ - "This resource model represents something we use on a day-to-day basis.", - "We use this to model one of the devices in our system.", - "This model tracks one of the elements of our cloud infrastructure." - ] - }, - "schema": { - "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "required": [ - "_id", - "name", - "workflow", - "preWorkflowJst", - "postWorkflowJst", - "type" - ], - "additionalProperties": false, - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The _id of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "description": "The UUIDv4 identifying a workflow" - } - ] - }, - "inputSchema": { - "description": "The schema describing inputs to this action", - "type": "object" - }, - "outputSchema": { - "description": "The schema describing inputs to this action", - "type": "object" - } - } - } - }, - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource model" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource model" - } - } - }, - "lifecycle-manager_resource-model-import": { - "type": "object", - "additionalProperties": false, - "required": ["model"], - "properties": { - "model": { - "type": "object", - "additionalProperties": false, - "required": [ - "_id", - "name", - "description", - "schema", - "created", - "createdBy", - "lastUpdated", - "lastUpdatedBy" - ], - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "description": { - "type": "string", - "description": "Free-form text describing the resource model", - "default": "", - "examples": [ - "This resource model represents something we use on a day-to-day basis.", - "We use this to model one of the devices in our system.", - "This model tracks one of the elements of our cloud infrastructure." - ] - }, - "schema": { - "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - } - }, - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "createdBy": { - "description": "The account identifier of the user who created this resource model" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - }, - "lastUpdatedBy": { - "description": "The account identifier of the user who last updated this resource model" - } - }, - "definitions": { - "action-workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "action": { - "type": "object", - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_id": { - "description": "The identifier of an action" - }, - "name": { - "description": "The name of the action", - "type": "string", - "examples": ["Create", "Update", "Suspend", "Reboot"] - }, - "type": { - "description": "The type of the action", - "enum": ["import", "create", "update", "delete"] - }, - "preWorkflowJst": { - "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - }, - "workflow": { - "description": "The name of the workflow to use as the implementation of this action.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "postWorkflowJst": { - "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", - "oneOf": [ - { - "type": "null" - }, - { - "title": "MongoDB.ObjectId", - "description": "A MongoDB ObjectId", - "type": "string", - "pattern": "^[0-9a-fA-F]{24}$", - "examples": ["62a1f3d2ebedfc54e6e0065c"] - } - ] - } - } - } - } - } - }, - "overwrite": { - "type": "boolean" - } - } - }, - "lifecycle-manager_resource-model-search-params": { - "type": "object", - "additionalProperties": false, - "required": [], - "allOf": [ - { - "type": "object", - "properties": { - "skip": { - "description": "This parameter specifies where to start the returned page of search results.", - "type": "string" - }, - "limit": { - "description": "This parameter specifies how many items to return in the search results.", - "type": "string" - } - } - }, - { - "type": "object", - "properties": { - "sort": { - "description": "This parameter specifies the field to sort the search results over.", - "type": "string", - "examples": ["name", "created"] - }, - "order": { - "description": "This parameter specifies the direction to sort the search results over.", - "enum": ["asc", "desc"] - } - } - }, - { - "type": "object", - "properties": { - "equals": { - "type": "object", - "properties": { - "_id": {}, - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - }, - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "starts-with": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - } - } - }, - "contains": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the resource model", - "examples": [ - "VLAN Service", - "EC2 Instance", - "ServiceNow Ticket" - ] - } - } - }, - "lt": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "lte": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "gt": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "gte": { - "type": "object", - "properties": { - "created": { - "description": "An ISO date string denoting when this resource model was created" - }, - "lastUpdated": { - "description": "An ISO date string denoting when this resource model was last updated" - } - } - }, - "dereference": { - "description": "Comma-separated list of field types to dereference", - "type": "string" - } - } - } - ] - } - }, - "securitySchemes": { - "CookieAuth": { - "type": "apiKey", - "name": "token", - "in": "cookie" - }, - "QueryAuth": { - "type": "apiKey", - "name": "token", - "in": "query" - }, - "BasicAuth": { - "type": "http", - "scheme": "basic" - } - } - } -}