Skip to main content
API docs by Redocly

System API (1.0.0)

Download OpenAPI specification:Download

files

Upload a file

Upload a file

Authorizations:
jwt
Request Body schema: multipart/form-data
bucket
required
string
Enum: "images" "files"
type
required
string
Enum: "sample" "avatar" "weighbridge" "contract" "image" "logo" "misc" "vehicle" "terms-conditions" "logistics-delivery" "logistics-load"

Name of the different file types in use (contract, sample etc)

file
required
Array of strings <binary>
name
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "tags": [
    ],
  • "info": {
    },
  • "organisationId": "string",
  • "userId": "string",
  • "type": "string",
  • "status": "active"
}

Download a file

Download a file

Authorizations:
jwt
path Parameters
id
required
string

Id of the file to download

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "stack": "string",
  • "code": "string",
  • "body": { },
  • "validation": [
    ]
}

Delete file

Archives a file.

Authorizations:
jwt
path Parameters
id
required
string

Id of the file to download

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "stack": "string",
  • "code": "string",
  • "body": { },
  • "validation": [
    ]
}

Request file information

Request file information without downloading it

Authorizations:
jwt
path Parameters
id
required
string

Id of the file to download

Responses

Response samples

Content type
application/json
{
  • "bucket": "string",
  • "type": "sample",
  • "organisationId": "string",
  • "name": "string",
  • "hash": "string",
  • "contentType": "string",
  • "url": "string",
  • "userId": "string"
}

initialise

Retrieve system settings

Initial API to get required data for the client

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

cache

Create cache

API to update the cache

Authorizations:
jwt
Request Body schema: application/json
keys
Array of strings
prefixes
Array of strings
flush
boolean or null
Default: false
secrets
boolean or null
Default: false

Responses

Request samples

Content type
application/json
{
  • "keys": [
    ],
  • "prefixes": [
    ],
  • "flush": false,
  • "secrets": false
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

System service

Ping api

Ping system api

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Execute event

Execute event in system module

Authorizations:
jwt
path Parameters
action
required
string

Action to perform

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Update system settings

Change the system settings document in the system module

Authorizations:
jwt
Request Body schema: application/json
required
object
level
required
string
filter
required
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}