Skip to main content

Get by ID

This endpoint allows you to find data.

Endpoint: /api/v1/file-details/{id}

Method: GET

Path Parameters

documentId: ID of the scope.

200 (OK) The request was successful, and the server has getting artifact details.

Body:

{
"status": "enum",
"message": "string",
"metadata": "object",
"data": {
"id" : "string",
"fileDetailId": "string",
"scopeId": "string",
"scope": "enum",
"status": "enum",
"path": "string",
"preSignUrl": "url",
"name": "string",
"creator": "string",
"creationDate" : "instant",
"size" : "integer",
"pageCount": "integer"
}
}

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

Body:

{
"status": "string",
"message": "string",
"timestamp": "date",
"data": "string",
"version": "string"
}

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

Body:

{
"status": "enum",
"message": "string",
"metadata": "object",
"data": {
"error": {
"Details": "String",
"Code" : "integer"
}
}
}

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

Body:

{
"status": "enum",
"message": "string",
"metadata": "object",
"data": {
"error": {
"Details": "String",
"Code" : "integer"
}
}
}

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

Body:

{
"message": "string",
"timestamp": "date",
"data": "string",
"version": "string"
}