Artemis Web API (1.0.0)

Download OpenAPI specification:Download

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

login

API for credentials and LDAP authentication

User logs in with credentials (email/password).

Request Body schema: application/json

email	string
password	string
rememberMe	boolean

Responses

Request samples

Payload

Content type

application/json

{
                                  
                                    
                                      
                                        "email":
                                        "string",
                                      
                                    
                                    
                                      
                                        "password":
                                        "string",
                                      
                                    
                                    
                                      
                                        "rememberMe":
                                        true
                                      
                                    
                                  
                                  }

Response samples

200

Content type

application/json

{
                                  
                                    
                                      
                                        "user":
                                        {
                                        
                                          
                                            
                                              "_id":
                                              "string",
                                            
                                          
                                          
                                            
                                              "name":
                                              "string",
                                            
                                          
                                          
                                            
                                              "email":
                                              "string",
                                            
                                          
                                          
                                            
                                              "role":
                                              "string",
                                            
                                          
                                          
                                            
                                              "lastLogin":
                                              "string"
                                            
                                          
                                        
                                        }
                                      
                                    
                                  
                                  }

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

Request Body schema: application/json

email	string
password	string
rememberMe	boolean

Responses

Request samples

Payload

Content type

application/json

{
                                  
                                    
                                      
                                        "email":
                                        "string",
                                      
                                    
                                    
                                      
                                        "password":
                                        "string",
                                      
                                    
                                    
                                      
                                        "rememberMe":
                                        true
                                      
                                    
                                  
                                  }

Response samples

200

Content type

application/json

{
                                  
                                    
                                      
                                        "user":
                                        {
                                        
                                          
                                            
                                              "_id":
                                              "string",
                                            
                                          
                                          
                                            
                                              "name":
                                              "string",
                                            
                                          
                                          
                                            
                                              "email":
                                              "string",
                                            
                                          
                                          
                                            
                                              "role":
                                              "string",
                                            
                                          
                                          
                                            
                                              "lastLogin":
                                              "string"
                                            
                                          
                                        
                                        }
                                      
                                    
                                  
                                  }

User logout

Responses

user account

API related to the user's account

Change user's password

Request Body schema: application/json

old_password	string
new_password	string

Responses

Request samples

Payload

Content type

application/json

{
                                  
                                    
                                      
                                        "old_password":
                                        "string",
                                      
                                    
                                    
                                      
                                        "new_password":
                                        "string"
                                      
                                    
                                  
                                  }

Create new account

Request Body schema: application/json

email	string
password	string
name	string

Responses

Request samples

Payload

Content type

application/json

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

Get user information

Responses

Response samples

200

Content type

application/json

{
                                  
                                    
                                      
                                        "user":
                                        {
                                        
                                          
                                            
                                              "_id":
                                              "string",
                                            
                                          
                                          
                                            
                                              "name":
                                              "string",
                                            
                                          
                                          
                                            
                                              "email":
                                              "string",
                                            
                                          
                                          
                                            
                                              "role":
                                              "string",
                                            
                                          
                                          
                                            
                                              "lastLogin":
                                              "string"
                                            
                                          
                                        
                                        }
                                      
                                    
                                  
                                  }

session

API for handling the session state

Retrieve JWT.

Responses

Response samples

200

Content type

application/json

{
                                  
                                    
                                      
                                        "accessToken":
                                        "string"
                                      
                                    
                                  
                                  }

data

API for retrieving miscellaneous application data

Get the configuration data

Responses

Response samples

200

Content type

application/json

{
                                  
                                    
                                      
                                        "configs":
                                        [
                                        
                                          
                                            
                                              {
                                              
                                                
                                                  
                                                    "raw_config":
                                                    "string",
                                                  
                                                
                                                
                                                  
                                                    "comment":
                                                    "string",
                                                  
                                                
                                                
                                                  
                                                    "time_modified":
                                                    "string"
                                                  
                                                
                                              
                                              }
                                            
                                          
                                        
                                        ]
                                      
                                    
                                  
                                  }

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

Request Body schema: application/json

action	string
parameters	string

Responses

Request samples

Payload

Content type

application/json

{
                                  
                                    
                                      
                                        "action":
                                        "string",
                                      
                                    
                                    
                                      
                                        "parameters":
                                        "string"
                                      
                                    
                                  
                                  }

Response samples

200

Content type

application/json

{
                                  
                                    
                                      
                                        "configs":
                                        [
                                        
                                          
                                            
                                              {
                                              
                                                
                                                  
                                                    "raw_config":
                                                    "string",
                                                  
                                                
                                                
                                                  
                                                    "comment":
                                                    "string",
                                                  
                                                
                                                
                                                  
                                                    "time_modified":
                                                    "string"
                                                  
                                                
                                              
                                              }
                                            
                                          
                                        
                                        ]
                                      
                                    
                                  
                                  }