Xóa Tài Liệu

1.1 Mục đích sử dụng :

Dùng để xóa 1 tài liệu trên hệ thống xFile theo các thông số bên dưới

1.1. URI :

NameDescription

URI

{{gateway}}/v1/api/doc/delete?identifier={refCode}

Content-Type

application/json

Method

DELETE

1.2. Request :

1.2.1 Request Headers

NameRequiredDescriptionRemarks

X-API-Key

Y

API Key AWS

Authorization

Y

[xFile cấp cho đối tác]

1.2.2 Request Body - Params:

NameTypeRequiredDescriptionRemarks

identifier

String

Y

RefCode của tài liệu

1.2.3 Request Sample :

Request URI:

{{gateway}}/v1/api/doc/delete?identifier=0221dc12-0fb6-4980-a01c-fd8b93a65f0e

1.3. Response :

1.3.1 Response Body JSON :

NameTypeDescriptionRemarks

status

Long

Trạng thái kết quả api trả về

0 : Thành công

1 : Thất bại

data

Object

Kết quả api trả về

RefCode của tài liệu đã upload : Xóa tài liệu thành công

Null : Xóa tài liệu Thất bại

1.3.2 Response Sample:

Response Success data

{

"status": 0,

"data": "0221dc12-0fb6-4980-a01c-fd8b93a65f0e"

}

Response- Not Found data

{ "validation": { "messages": [], "validationResults": { "refCode": "validation.doc.notFound" } }, "type": "https://www.jhipster.tech/problem/constraint-violation", "title": "validation_exception", "status": 400 }

Last updated