Nesis API 0.1.1

The Nesis API helps you extend your existing and legacy applications easily giving them AI capabilities powered by Nesis.

First create a role for your App,
Then create an App assigning the role to it. The API key returned can then be used as the Authorization token for automating creating Users, Roles, Datasources and more.

See the working example on the left menu on how to use the API.

Endpoints

POST /v1/sessions

Creates a new user session.

Request body

application/json

{
    "email": "derp@meme.org",
    "password": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "email": {
            "type": "string",
            "format": "email"
        },
        "password": {
            "type": "string"
        }
    }
}

Response 200 OK

application/json

{
    "token": "string",
    "user": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "token": {
            "type": "string"
        },
        "user": {
            "type": "object"
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

DELETE /v1/sessions

Delete a session.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No

Response 200 OK

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/users

Get all users available.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No

Response 200 OK

application/json

{
    "items": [
        {
            "name": "string",
            "email": "string",
            "password": "string",
            "id": "string",
            "status": "string",
            "create_date": "string"
        }
    ],
    "count": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/UserRes"
            }
        },
        "count": {
            "type": "integer"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

POST /v1/users

Creates a new user.

Request body

application/json

{
    "name": "string",
    "email": "string",
    "password": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "email": {
            "type": "string"
        },
        "password": {
            "type": "string"
        }
    }
}

Response 200 OK

application/json

{
    "name": "string",
    "email": "string",
    "password": "string",
    "id": "string",
    "status": "string",
    "create_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "email": {
            "type": "string"
        },
        "password": {
            "type": "string"
        },
        "id": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/users/{user_id}

Get a single user by user_id.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.
`user_id`	path	string		No	The user id to get

Response 200 OK

application/json

{
    "name": "string",
    "email": "string",
    "password": "string",
    "id": "string",
    "status": "string",
    "create_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "email": {
            "type": "string"
        },
        "password": {
            "type": "string"
        },
        "id": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

DELETE /v1/users/{user_id}

Delete a single user by user_id.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.
`user_id`	path	string		No	The user id to delete

Response 200 OK

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

PUT /v1/users/{user_id}

Updates a new user.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.

Request body

application/json

{
    "name": "string",
    "email": "string",
    "password": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "email": {
            "type": "string"
        },
        "password": {
            "type": "string"
        }
    }
}

Response 200 OK

application/json

{
    "name": "string",
    "email": "string",
    "password": "string",
    "id": "string",
    "status": "string",
    "create_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "email": {
            "type": "string"
        },
        "password": {
            "type": "string"
        },
        "id": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/apps

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.

Response 200 OK

application/json

{
    "items": [
        {
            "name": "string",
            "description": "string",
            "id": "string",
            "enabled": true,
            "create_date": "string"
        }
    ],
    "count": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/AppRes"
            }
        },
        "count": {
            "type": "integer"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

POST /v1/apps

Creates a new app.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.

Request body

application/json

{
    "name": "string",
    "description": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "description": {
            "type": "string"
        }
    }
}

Response 200 OK

application/json

{
    "name": "string",
    "description": "string",
    "id": "string",
    "enabled": true,
    "create_date": "string",
    "secret": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "id": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        },
        "secret": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/tasks

Get all tasks available.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No

Response 200 OK

application/json

{
    "items": [
        {
            "name": "string",
            "description": "string",
            "enabled": true,
            "type": "string",
            "schedule": "string",
            "parent_id": "string",
            "definition": {},
            "id": "string",
            "status": "string",
            "create_date": "string",
            "update_date": "string"
        }
    ],
    "count": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskRes"
            }
        },
        "count": {
            "type": "integer"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

POST /v1/tasks

Creates a new task.

Request body

application/json

{
    "name": "string",
    "description": "string",
    "enabled": true,
    "type": "string",
    "schedule": "string",
    "parent_id": "string",
    "definition": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "type": {
            "type": "string"
        },
        "schedule": {
            "type": "string"
        },
        "parent_id": {
            "type": "string"
        },
        "definition": {
            "type": "object"
        }
    }
}

Response 200 OK

application/json

{
    "name": "string",
    "description": "string",
    "enabled": true,
    "type": "string",
    "schedule": "string",
    "parent_id": "string",
    "definition": {},
    "id": "string",
    "status": "string",
    "create_date": "string",
    "update_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "type": {
            "type": "string"
        },
        "schedule": {
            "type": "string"
        },
        "parent_id": {
            "type": "string"
        },
        "definition": {
            "type": "object"
        },
        "id": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        },
        "update_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/tasks/{task_id}

Get a single task by task_id.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.
`task_id`	path	string		No	The task id to get

Response 200 OK

application/json

{
    "name": "string",
    "description": "string",
    "enabled": true,
    "type": "string",
    "schedule": "string",
    "parent_id": "string",
    "definition": {},
    "id": "string",
    "status": "string",
    "create_date": "string",
    "update_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "type": {
            "type": "string"
        },
        "schedule": {
            "type": "string"
        },
        "parent_id": {
            "type": "string"
        },
        "definition": {
            "type": "object"
        },
        "id": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        },
        "update_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

DELETE /v1/tasks/{task_id}

Delete a single task by task_id.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.
`task_id`	path	string		No	The task id to delete

Response 200 OK

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

PUT /v1/tasks/{task_id}

Creates a new task.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No

Request body

application/json

{
    "name": "string",
    "description": "string",
    "enabled": true,
    "type": "string",
    "schedule": "string",
    "parent_id": "string",
    "definition": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "type": {
            "type": "string"
        },
        "schedule": {
            "type": "string"
        },
        "parent_id": {
            "type": "string"
        },
        "definition": {
            "type": "object"
        }
    }
}

Response 200 OK

application/json

{
    "name": "string",
    "description": "string",
    "enabled": true,
    "type": "string",
    "schedule": "string",
    "parent_id": "string",
    "definition": {},
    "id": "string",
    "status": "string",
    "create_date": "string",
    "update_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "type": {
            "type": "string"
        },
        "schedule": {
            "type": "string"
        },
        "parent_id": {
            "type": "string"
        },
        "definition": {
            "type": "object"
        },
        "id": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        },
        "update_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/roles

Get all roles available.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No

Response 200 OK

application/json

{
    "items": [
        {
            "items": [
                {}
            ],
            "id": "string",
            "create_date": "string"
        }
    ],
    "count": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/RoleRes"
            }
        },
        "count": {
            "type": "integer"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

POST /v1/roles

Creates a new role.

Request body

application/json

{
    "items": [
        {}
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PolicyAction"
            }
        }
    }
}

Response 200 OK

application/json

{
    "items": [
        {}
    ],
    "id": "string",
    "create_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PolicyAction"
            }
        },
        "id": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/roles/{role_id}

Get a single role by roleId.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No
`roleId`	path	string		No	The role id to get

Response 200 OK

application/json

{
    "items": [
        {}
    ],
    "id": "string",
    "create_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PolicyAction"
            }
        },
        "id": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

DELETE /v1/roles/{role_id}

Delete a single role by roleId.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No
`taskId`	path	string		No	The role id to delete

Response 200 OK

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

PUT /v1/roles/{role_id}

Creates a new task.

Request body

application/json

{
    "items": [
        {}
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PolicyAction"
            }
        }
    }
}

Response 200 OK

application/json

{
    "items": [
        {}
    ],
    "id": "string",
    "create_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PolicyAction"
            }
        },
        "id": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/datasources

Get all datasources available.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.

Response 200 OK

application/json

{
    "items": [
        {
            "name": "string",
            "enabled": true,
            "schedule": "string",
            "connection": {},
            "id": "string",
            "status": "string",
            "create_date": "string"
        }
    ],
    "count": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/DatasourceRes"
            }
        },
        "count": {
            "type": "integer"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

POST /v1/datasources

Creates a new datasource.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.

Request body

application/json

{
    "name": "string",
    "enabled": true,
    "schedule": "string",
    "connection": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "schedule": {
            "type": "string"
        },
        "connection": {
            "type": "object"
        }
    }
}

Response 200 OK

application/json

{
    "name": "string",
    "enabled": true,
    "schedule": "string",
    "connection": {},
    "id": "string",
    "status": "string",
    "create_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "schedule": {
            "type": "string"
        },
        "connection": {
            "type": "object"
        },
        "id": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/datasources/{datasource_id}

Get a single datasource by datasource_id.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.
`datasource_id`	path	string		No	The datasource id to get

Response 200 OK

application/json

{
    "name": "string",
    "enabled": true,
    "schedule": "string",
    "connection": {},
    "id": "string",
    "status": "string",
    "create_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "schedule": {
            "type": "string"
        },
        "connection": {
            "type": "object"
        },
        "id": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

DELETE /v1/datasources/{datasource_id}

Delete a single datasource by datasource_id.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.
`datasource_id`	path	string		No	The datasource id to delete

Response 200 OK

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

PUT /v1/datasources/{datasource_id}

Creates a new datasource.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.

Request body

application/json

{
    "name": "string",
    "enabled": true,
    "schedule": "string",
    "connection": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "schedule": {
            "type": "string"
        },
        "connection": {
            "type": "object"
        }
    }
}

Response 200 OK

application/json

{
    "name": "string",
    "enabled": true,
    "schedule": "string",
    "connection": {},
    "id": "string",
    "status": "string",
    "create_date": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "enabled": {
            "type": "boolean"
        },
        "schedule": {
            "type": "string"
        },
        "connection": {
            "type": "object"
        },
        "id": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "create_date": {
            "type": "string",
            "format": null,
            "pattern": null
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

GET /v1/modules/{module}/predictions

Get all predictions available.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.
`module`	path	string		No	The module. Must be 'qanda'

Response 200 OK

application/json

{
    "items": [
        {
            "query": "string",
            "save": true,
            "id": "string",
            "data": {}
        }
    ],
    "count": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PredictionRes"
            }
        },
        "count": {
            "type": "integer"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

POST /v1/modules/{module}/predictions

Creates a new prediction.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`Authorization`	header	string		No	The authentication token obtained from a POST /session or POST /apps.
`X-Nesis-Request-UserKey`	header	string		No	The user_id to inherit permissions from. This is useful when the Authorization header is an app API token.

Request body

application/json

{
    "query": "string",
    "save": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "query": {
            "type": "string"
        },
        "save": {
            "type": "boolean"
        }
    }
}

Response 200 OK

application/json

{
    "query": "string",
    "save": true,
    "id": "string",
    "data": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "query": {
            "type": "string"
        },
        "save": {
            "type": "boolean"
        },
        "id": {
            "type": "string"
        },
        "data": {
            "type": "object"
        }
    }
}

Response 400 Bad Request

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 401 Unauthorized

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "type": "string",
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}

Schemas

AppPostRes

Name	Type
`create_date`	string
`description`	string
`enabled`	boolean
`id`	string
`name`	string
`secret`	string

AppReq

Name	Type
`description`	string
`name`	string

AppRes

Name	Type
`create_date`	string
`description`	string
`enabled`	boolean
`id`	string
`name`	string

Apps

Name	Type
`count`	integer
`items`	Array<AppRes>

DatasourceReq

Name	Type
`connection`
`enabled`	boolean
`name`	string
`schedule`	string

DatasourceRes

Name	Type
`connection`
`create_date`	string
`enabled`	boolean
`id`	string
`name`	string
`schedule`	string
`status`	string

Datasources

Name	Type
`count`	integer
`items`	Array<DatasourceRes>

Message

Name	Type
`message`	string
`type`	string

PolicyAction

PredictionReq

Name	Type
`query`	string
`save`	boolean

PredictionRes

Name	Type
`data`
`id`	string
`query`	string
`save`	boolean

Predictions

Name	Type
`count`	integer
`items`	Array<PredictionRes>

RoleReq

Name	Type
`items`	Array<PolicyAction>

RoleRes

Name	Type
`create_date`	string
`id`	string
`items`	Array<PolicyAction>

Roles

Name	Type
`count`	integer
`items`	Array<RoleRes>

SessionReq

Name	Type
`email`	string(email)
`password`	string

SessionRes

Name	Type
`token`	string
`user`

TaskReq

Name	Type
`definition`
`description`	string
`enabled`	boolean
`name`	string
`parent_id`	string
`schedule`	string
`type`	string

TaskRes

Name	Type
`create_date`	string
`definition`
`description`	string
`enabled`	boolean
`id`	string
`name`	string
`parent_id`	string
`schedule`	string
`status`	string
`type`	string
`update_date`	string

Tasks

Name	Type
`count`	integer
`items`	Array<TaskRes>

UserReq

Name	Type
`email`	string
`name`	string
`password`	string

UserRes

Name	Type
`create_date`	string
`email`	string
`id`	string
`name`	string
`password`	string
`status`	string

Users

Name	Type
`count`	integer
`items`	Array<UserRes>