The REST API handles CRUD (Create, Retrieve, Update, Delete) operations for all entities, retrieving data using the FETCH language and executing custom workflows.
...
Server information and authentication.
Until 1.7.0
Parameters
Name | Where | Description | Schema |
|---|---|---|---|
user | query | the user name | string |
password | query | the user password | string |
Responses
200 Ok
The operation was successful.
...
Retrieve an entity from the database.
Parameters
Name | Where | Required Value | Description | Schema |
|---|---|---|---|---|
entityName | url | the name of the entity to retrieve | string | |
key | url | the key of the entity ro retrieve | long | |
Content-Type | headers | application/json | The content-type. |
Responses
200 Ok
The operation was successful.
...
Create or update an instance of an entity.
Parameters
Name | Where | Required Value | Description | Schema |
|---|---|---|---|---|
entityName | url | The name of the entity to update. | string | |
key | url | Optional. Only for updates. | long | |
Content-Type | headers | application/json | The content-type. |
Payload
| Code Block | ||
|---|---|---|
| ||
{
"entity_name": "the_name",
"properties": {
"key": 1, //Optional
"a_property": "value"
},
"children": {
"the_name_the_items": [
"entity_name": "the_items",
"properties": {
"key": 10, //Optional
"other_property": 10
}
]
}
} |
...
Delete an entity.
Parameters
Name | Where | Required Value | Description | Schema |
|---|---|---|---|---|
entityName | url | The name of the entity to delete | string | |
key | url | The key of the entity to delete. | long | |
Content-Type | headers | application/json | The content-type. |
Responses
200 Ok
The operation was successful.
...
Execute a workflow.
Parameters
Name | Where | Required Value | Description | Schema |
|---|---|---|---|---|
workflowName | url | The name workflow to run. | string | |
workflowMethod | url | The name of the workflow method to run. | string | |
Content-Type | headers | application/json | The content-type. |
Payload
| Code Block | ||
|---|---|---|
| ||
{
"argument1": "value",
"argument2": 10,
"argument3": "2012-01-01T11:00:00"
"argument4": 12.2
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"detail": "error detail"
} |
401 Unauthorized
The operation is not authorized.
...
Execute a query against the database.
Parameters
Name | Where | Required Value | Description | Schema |
|---|---|---|---|---|
Content-Type | headers | text/plain | The content-type. | string |
Payload
The fetch query. See FETCH query language.
...