Skip to main content

Save index

This endpoint allows you to sae index.

Endpoint: /api/v1/indices

Method: POST

Request Body

Media Type: application/json

Body:

{
"indexIri": "string",
"dataTransformerRunId": "string",
"artifactIds": [
"string"
],
"data": {
"key": "string",
"value": "string"
}
}

indexIri (required): The IRI of the index definition dataTransformerRunId (required): ID of the data transformer run.
artifactIds (required): List of related artifact IDs.
data (required): List of object with key and value fields, where key corresponds to the column name of index table and value is the column value.

Responses

200 (OK) Request processed successfully.

Body:

{
"status": "success",
"message": "Request processed successfully",
"metadata": {
"timestamp": "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"
}