Create index definition

This endpoint allows you to create index definition.

Endpoint: /api/v1/index-definitions

Method: POST

Request Body

Media Type: application/json

Body:

{
  "indexIri": "string",
  "indexName": "string",
  "artifactDefinitionIRIs": ["string"],
  "schema": "JSON"
}

Responses

200 (OK) Request processed successfully.

Body:

{
  "status": "success",
  "message": "Request processed successfully",
  "metadata": {
    "timestamp": "date"
  },
  "data": {
    "id": "UUID",
    "creationDate": "date",
    "creator": "string",
    "iri": "string",
    "name": "string"
  }
}

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