Skip to main content

Find all index definitions

This endpoint allows you to find all index definitions from database.

Endpoint: /api/v1/index-definitions

Method: GET

Responses

200 (OK) Request processed successfully.

Body:

{
"status": "success",
"message": "Request processed successfully",
"metadata": {
"timestamp": "date"
},
"data": [
{
"id": "UUID",
"iri": "string",
"schema": "JSON",
"name": "string",
"artifactDefinitions": [
{
"name": "string",
"description": "string",
"iri": "string",
"dataType": "string",
"creator": "string",
"creationDate": "date"
}
]
}
]
}

401 (Unauthorized) This response is returned if the request is not authorized.

Body:

{
"status": "enum",
"message": "string",
"metadata": {
"string": "string"
},
"data": "object"
}

404 (Not Found) This response is returned if the required resources are not found.

Body:

{
"status": "enum",
"message": "string",
"metadata": {
"string": "string"
},
"data": "object"
}

412 (Precondition Failed) This response is returned if a precondition is not met.

Body:

{
"status": "enum",
"message": "string",
"metadata": {
"string": "string"
},
"data": "object"
}

500 (Internal Server Error) This response is returned if an unexpected internal server error occurs.

Body:

{
"status": "enum",
"message": "string",
"metadata": {
"string": "string"
},
"data": "object"
}