Download OpenAPI specification:Download
Access Alumio through OpenAPI v3.0.
Get a token reference
| space | any Space identifier |
| baseUri | string |
| clientId | string |
| clientSecret | string |
| user | string |
| password | string |
{- "baseUri": "string",
- "clientId": "string",
- "clientSecret": "string",
- "user": "string",
- "password": "string"
}Create user
| space | any Space identifier |
| email required | string (Email address) |
| roles required | Array of strings (Roles) non-empty unique Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR" |
{- "email": "string",
- "roles": [
- "ROLE_EDITOR"
]
}Update a user
| email required | any User email |
| space | any Space identifier |
| email required | string (Email address) |
| roles required | Array of strings (Roles) non-empty unique Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR" |
{- "email": "string",
- "roles": [
- "ROLE_EDITOR"
]
}| direction | any Direction to resolve relations |
| space | any Space identifier |
Array of objects |
{- "objects": [
- {
- "type": "string",
- "identifier": "string"
}
]
}Import object configurations
| dry-run | any Only validate and check whether configurations already exist. |
| space | any Space identifier |
required | Class name (string) or Identifier (string) (type) |
| identifier required | string (Identifier) >= 2 characters ^[a-z0-9]+[a-z0-9\-]*[a-z0-9]+$ |
| name required | string |
| description | string |
required | prototype.configuration (object) or default.prototype.configuration (object) |
[- {
- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": {
- "prototype": "string",
- "parameters": { }
}
}
]Bulk export object configurations
| space | any Space identifier |
Array of objects | |
| clientTime | string^\d+$ |
{- "objects": [
- {
- "type": "string",
- "identifier": "string"
}
], - "clientTime": "string"
}Create an object configuration
| space | any Space identifier |
| type required | string (Type) Type |
| identifier required | string (Identifier) <= 255 characters ^[a-z0-9-]+$ Identifier |
| name required | string (Name) <= 255 characters Name |
| description | string or null (Description) <= 64000 characters Default: "" Description |
| object required | object |
| context | object |
| owner | string (Owner) The identifier of the owner of the configuration. |
| removable | boolean Default: false Whether the configuration can be removed through the API |
| resettable | boolean Default: false Whether the configuration can be reset through the API |
| disabled | boolean (Status) Default: false Whether the configuration is disabled |
| createdAt | string <date-time> (Created at) Creation date |
| updatedAt | string <date-time> (Updated at) Update date |
| editor | string (Last edited by) The email of the last person who edited the configuration |
{- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "",
- "object": { },
- "context": { },
- "owner": "string",
- "removable": false,
- "resettable": false,
- "disabled": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "editor": "string"
}Update an object configuration
| space | any Space identifier |
| type required | string (Type) Type |
| identifier required | string (Identifier) <= 255 characters ^[a-z0-9-]+$ Identifier |
| name required | string (Name) <= 255 characters Name |
| description | string or null (Description) <= 64000 characters Default: "" Description |
| object required | object |
| context | object |
| owner | string (Owner) The identifier of the owner of the configuration. |
| removable | boolean Default: false Whether the configuration can be removed through the API |
| resettable | boolean Default: false Whether the configuration can be reset through the API |
| disabled | boolean (Status) Default: false Whether the configuration is disabled |
| createdAt | string <date-time> (Created at) Creation date |
| updatedAt | string <date-time> (Updated at) Update date |
| editor | string (Last edited by) The email of the last person who edited the configuration |
{- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "",
- "object": { },
- "context": { },
- "owner": "string",
- "removable": false,
- "resettable": false,
- "disabled": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "editor": "string"
}Update an object configuration status
| type required | any Type identifier |
| identifier required | any Configuration identifier |
| space | any Space identifier |
| disabled required | boolean (Status) Whether the configuration is disabled |
{- "disabled": true
}Create an object relation
| type required | any Type identifier |
| owner required | any Owner identifier |
| space | any Space identifier |
| type | string (Type) |
| identifier | string (Identifier) <= 255 characters ^[a-z0-9-]+$ |
| name | string (Name) <= 255 characters |
| description | string (Description) <= 64000 characters |
| object | object (Prototype) |
| removable | boolean Default: false Whether the relation can be removed through the API |
| resettable | boolean Default: false Whether the relation can be reset through the API |
| disabled | boolean (Disabled) Default: false Whether the configuration is disabled |
| editor | string (Last edited by) The email of the person who last edited this |
{- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": { },
- "removable": false,
- "resettable": false,
- "disabled": false,
- "editor": "string"
}Update an object relation
| type required | any Type identifier |
| owner required | any Owner identifier |
| identifier required | any Relation identifier |
| space | any Space identifier |
| type | string (Type) |
| identifier | string (Identifier) <= 255 characters ^[a-z0-9-]+$ |
| name | string (Name) <= 255 characters |
| description | string (Description) <= 64000 characters |
| object | object (Prototype) |
| removable | boolean Default: false Whether the relation can be removed through the API |
| resettable | boolean Default: false Whether the relation can be reset through the API |
| disabled | boolean (Disabled) Default: false Whether the configuration is disabled |
| editor | string (Last edited by) The email of the person who last edited this |
{- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": { },
- "removable": false,
- "resettable": false,
- "disabled": false,
- "editor": "string"
}Create a new environment variable
| space | any Space identifier |
| name required | string (Name) ^[a-zA-Z0-9_-]+$ |
| encrypted | boolean (Encrypted) |
| value required | string |
{- "name": "string",
- "encrypted": true,
- "value": "string"
}Export storage entities matching the filter
| identifier required | any Storage identifier. |
| space | any Space identifier |
| filter | string |
| clientTime | string^\d+$ |
{- "filter": "string",
- "clientTime": "string"
}null