Documentation Powered by ReDoc

Artemis Web API (1.0.0)

Download OpenAPI specification:Download

This is the documentation of the Artemis REST API accessible to normal users.

In order to authenticate for the API:

  • Use the session cookie (get it with /api/auth/login/credentials or /api/auth/login/ldap)
  • The x-artemis-api-key header is used to circumvent the csrf protection.

login

API for credentials and LDAP authentication

User logs in with credentials (email/password).

header Parameters
x-artemis-api-key
required
string <uuid>
Request Body schema: application/json
email
string
password
string
rememberMe
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "rememberMe": true
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

User logs in with her ldap credentials (email/password).

header Parameters
x-artemis-api-key
required
string <uuid>
Request Body schema: application/json
email
string
password
string
rememberMe
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "rememberMe": true
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

User logout

cookie Parameters
sid
required
string
header Parameters
x-artemis-api-key
required
string <uuid>

Responses

user account

API related to the user's account

Change user's password

cookie Parameters
sid
required
string
header Parameters
x-artemis-api-key
required
string <uuid>
Request Body schema: application/json
old_password
string
new_password
string

Responses

Request samples

Content type
application/json
{
  • "old_password": "string",
  • "new_password": "string"
}

Create new account

header Parameters
x-artemis-api-key
required
string <uuid>
Request Body schema: application/json
email
string
password
string
name
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "name": "string"
}

Get user information

cookie Parameters
sid
required
string
header Parameters
x-artemis-api-key
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

session

API for handling the session state

Retrieve JWT.

cookie Parameters
sid
required
string
header Parameters
x-artemis-api-key
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string"
}

data

API for retrieving miscellaneous application data

Get the configuration data

cookie Parameters
sid
required
string
header Parameters
x-artemis-api-key
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "configs": [
    ]
}

Get data for the table described in the action field, in json format

cookie Parameters
sid
required
string
header Parameters
x-artemis-api-key
required
string <uuid>
Request Body schema: application/json
action
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "action": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
[
  • { }
]