Reference API
- Claudius Knaak
Owned by Claudius Knaak
Overview
Use the Reference API in order to manage the references of existing IBS-Entities.
Create
| Parameter | Type | Required | Comment |
|---|---|---|---|
| action | String |  | create see also API - General parameters |
| parent | uuid | | the uuid of the parent (=source) |
| child | uuid | | the uuid of the child (=target) |
See also Entity API#Create and Entity API#Update
Example call
/api/references?action=create&parent=4c88f515-893e-49ff-a3f1-23f58bc8ce53&child=707ebad4-1dba-40a6-8c36-3fe7a177885d POST /api/references parent=4c88f515-893e-49ff-a3f1-23f58bc8ce53 child=707ebad4-1dba-40a6-8c36-3fe7a177885d
Answer
Success
{
"type": "Result:ReferenceApi:Create:Success",
"uuid": "149a8e27-9bb7-4dd3-9bba-f4913b113504"
}
Error
different error states 
Delete
| Parameter | Type | Required | Comment |
|---|---|---|---|
| action | String | | delete see also API - General parameters |
| uuid | uuid | | see also API - General parameters |
See also Entity API#Create and Entity API#Update
Example call
/api/references?action=delete&uuid=149a8e27-9bb7-4dd3-9bba-f4913b113504 DELETE /api/references/149a8e27-9bb7-4dd3-9bba-f4913b113504
Answer
Success
{
"type": "Result:ReferenceApi:Delete:Success"
}
Error
different error states
Info
| Parameter | Type | Required | Comment |
|---|---|---|---|
| action | String | | info see also API - General parameters |
| uuid | uuid | | see also API - General parameters |
Example call
/api/references?action=info&uuid=149a8e27-9bb7-4dd3-9bba-f4913b113504 GET /api/references/149a8e27-9bb7-4dd3-9bba-f4913b113504
Answer
Success
{
"parent": "59dcb8f1-c3fc-4121-b7d3-7197ab8c5feb",
"creationdate": "2018-08-24 15:12:08",
"type": "Success:ReferenceApi:Info",
"modificationdate": "2018-08-24 15:12:08",
"uuid": "29f8f73a-1f1c-461f-9e94-d9be5a34b8a3",
"child": "a8b2c96c-f9a0-4702-bf73-6d6f8ef9c2d2"
}
Error
different error states
Update
| Parameter | Type | Required | Comment |
|---|---|---|---|
| action | String | | update see also API - General parameters |
| uuid | uuid | | see also API - General parameters |
| parent | uuid | the uuid of the parent (=source) | |
| child | uuid | the uuid of the child (=target) |
Example call
/api/references?action=update&uuid=149a8e27-9bb7-4dd3-9bba-f4913b113504&parent=59dcb8f1-c3fc-4121-b7d3-7197ab8c5feb PATCH /api/references/149a8e27-9bb7-4dd3-9bba-f4913b113504 parent=59dcb8f1-c3fc-4121-b7d3-7197ab8c5feb
Answer
Success
{
"type": "Result:ReferenceApi:Update:Success"
}
Error
different error states