{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cosmo Tech Manager dataset runner API",
    "version": "1.0.0-SNAPSHOT"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://example.com/authorize",
      "accessTokenUrl": "https://example.com/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "runner",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all Runners",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number to query (first page is at index 0)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Amount of result by page"
              }
            ]
          },
          "docs": "Retrieve a paginated list of all runners in a workspace."
        },
        {
          "info": {
            "name": "Create a new Runner",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new runner for executing simulations. Use parentId to create a child runner that inherits configuration from a parent."
        },
        {
          "info": {
            "name": "Get the details of a runner",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              }
            ]
          },
          "docs": "Retrieve detailed information about a runner."
        },
        {
          "info": {
            "name": "Update a runner",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a runner"
        },
        {
          "info": {
            "name": "Delete a runner",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              }
            ]
          },
          "docs": "Delete a runner. Cannot delete while runs are in progress. Note: Child runners that reference this runner are not deleted automatically."
        },
        {
          "info": {
            "name": "Start a run with runner parameters",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/start",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              }
            ]
          },
          "docs": "Start a new simulation run using the runner's current configuration. Returns the run Id. The run executes asynchronously - use the run status endpoint to monitor progress"
        },
        {
          "info": {
            "name": "Stop the last run",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/stop",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              }
            ]
          },
          "docs": "Stop the currently executing run for this runner. The stop operation is asynchronous - the run may continue briefly before stopping."
        },
        {
          "info": {
            "name": "Get the Runner permission by given role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/permissions/:role",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              },
              {
                "name": "role",
                "value": "",
                "type": "path",
                "description": "the Role"
              }
            ]
          },
          "docs": "Get the Runner permission by given role"
        },
        {
          "info": {
            "name": "Get the Runner security information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/security",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              }
            ]
          },
          "docs": "Get the Runner security information"
        },
        {
          "info": {
            "name": "Set the Runner default security",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/security/default",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set the Runner default security"
        },
        {
          "info": {
            "name": "Add a control access to the Runner",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/security/access",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Grant access to a runner for a user or group. Valid roles: viewer, editor, validator (can validate runs), admin."
        },
        {
          "info": {
            "name": "Get a control access for the Runner",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/security/access/:identity_id",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              },
              {
                "name": "identity_id",
                "value": "",
                "type": "path",
                "description": "the User identifier"
              }
            ]
          },
          "docs": "Get a control access for the Runner"
        },
        {
          "info": {
            "name": "Update the specified access to User for a Runner",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/security/access/:identity_id",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              },
              {
                "name": "identity_id",
                "value": "",
                "type": "path",
                "description": "the User identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the specified access to User for a Runner"
        },
        {
          "info": {
            "name": "Remove the specified access from the given Runner",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/security/access/:identity_id",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              },
              {
                "name": "identity_id",
                "value": "",
                "type": "path",
                "description": "the User identifier"
              }
            ]
          },
          "docs": "Remove the specified access from the given Runner"
        },
        {
          "info": {
            "name": "Get the Runner security users list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8080/organizations/:organization_id/workspaces/:workspace_id/runners/:runner_id/security/users",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "the Organization identifier"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path",
                "description": "the Workspace identifier"
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "the Runner identifier"
              }
            ]
          },
          "docs": "Get the Runner security users list"
        }
      ]
    }
  ],
  "bundled": true
}