API: Data objects

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}"
ParameterInput exampleTypeMandatory
clientcomplyonslugYes
page1numberNo
per_page10numberNo
sortnametextNo
orderasc, desctextNo
keywordnametextNo

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}"
ParameterInputTypeMandatory
dataobjectnameslugYes

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}"
ParameterInput exampleTypeMandatory
clientcomplyonslugYes
nameNametextYes
classificationGeneric art. 6textYes
descriptionText text texttextNo
categoryContact detailstextNo
tags[]tag1arrayNo

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}"
ParameterInput exampleTypeMandatory
dataobjectnameslugYes
nameNametextYes
classificationGeneric art. 6textNo
descriptionText text texttextNo
categoryContact detailstextNo
tags[]tag1arrayNo

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}"
ParameterInput exampleTypeMandatory
dataobjectnameslugYes
Was this article helpful?

Related Articles

Need Support?

Can't find the answer you're looking for?
Contact Support

Want to hear more?

Let's talk about how our experience and software can help your company.