REST API for Data objects
This page contains all APIs associated with data objects.
View list of all data objects
Returns a full list of all data objects on the specified client area.
curl -X GET \
"https://system.complyon.com/api/data-objects?client=${client_slug}" \
-H "accept: application/json" \
-H "Authorization: Bearer ${token}"| Parameter | Input example | Type | Mandatory |
|---|---|---|---|
| client | complyon | slug | Yes |
| page | 1 | number | No |
| per_page | 10 | number | No |
| sort | name | text | No |
| order | asc, desc | text | No |
| keyword | name | text | No |
If successful, the system will return the following JSON array:
{
"items": [
{
"id": 1,
"slug": "",
"name": "",
"classification": "",
"description": "",
"category": "",
"updated_at": "",
"business_classification": "",
"who_am_i": "App\\Maintenance\\DataObject\\Models\\DataObject",
"partition": false,
"created_by": {},
"tags_translated": [],
"updated_by": {}
}
]
}View single data object
Return a single data object.
curl -X GET \
"https://system.complyon.com/api/data-objects/${data_object_slug}" \
-H "accept: application/json" \
-H "Authorization: Bearer ${token}"| Parameter | Input | Type | Mandatory |
|---|---|---|---|
| dataobject | name | slug | Yes |
If successful, the system will return the following JSON:
{
"id": 1,
"slug": "",
"name": "",
"classification": "",
"description": "",
"category": "",
"updated_at": "",
"business_classification": "",
"who_am_i": "App\\Maintenance\\DataObject\\Models\\DataObject",
"partition": false,
"created_by": {},
"tags_translated": [],
"updated_by": {}
}Create data object
Create a single data object on a client.
curl -X POST \
"https://system.complyon.com/api/data-objects" \
-H "accept: application/json" \
-H "Authorization: Bearer ${token}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "name=${data_object_name}&classification=${data_object_classification}&description=${data_object_description}&category=${data_object_category}&tags[]=${data_object_tag_1}&tags[]=${data_object_tag_2}&client=${client_slug}"| Parameter | Input example | Type | Mandatory |
|---|---|---|---|
| client | complyon | slug | Yes |
| name | Name | text | Yes |
| classification | Generic art. 6 | text | Yes |
| description | Text text text | text | No |
| category | Contact details | text | No |
| tags[] | tag1 | array | No |
If successful, the system will return the following JSON:
{
"id": 1,
"slug": "",
"name": "",
"classification": "",
"description": "",
"category": "",
"updated_at": "",
"who_am_i": "App\\Maintenance\\DataObject\\Models\\DataObject",
"partition": false
}Update data object
Update/change a single data object.
curl -X PUT \
"https://system.complyon.com/api/data-objects/${data_object_slug}" \
-H "accept: application/json" \
-H "Authorization: Bearer ${token}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "name=${data_object_name}&classification=${data_object_classification}&description=${data_object_description}&category=${data_object_category}&tags[]=${data_object_tag_1}&tags[]=${data_object_tag_2}"| Parameter | Input example | Type | Mandatory |
|---|---|---|---|
| dataobject | name | slug | Yes |
| name | Name | text | Yes |
| classification | Generic art. 6 | text | No |
| description | Text text text | text | No |
| category | Contact details | text | No |
| tags[] | tag1 | array | No |
If successful, the system will return the following JSON:
{
"id": 1,
"slug": "",
"name": "",
"classification": "",
"description": "",
"category": "",
"updated_at": "",
"who_am_i": "App\\Maintenance\\DataObject\\Models\\DataObject",
"partition": false
"created_by": {},
"tags_translated": [],
"updated_by": {}
}Delete data object
Delete a single data object.
curl -X DELETE \
"https://system.complyon.com/api/data-objects/${data_object_slug}" \
-H "accept: application/json" \
-H "Authorization: Bearer ${token}"| Parameter | Input example | Type | Mandatory |
|---|---|---|---|
| dataobject | name | slug | Yes |