Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

Table of Contents

Changelogs

Version

Date

Changes by

Description of change

V1.0

Mar 29, 2024

Que Nguyen

  • Add Table of Contents.

  • Add Changelogs.

V1.0.1

April 10, 2024

Que Nguyen

  • Add Release Status table.

Release status

Environment

Status

Released Date

Version

DEV

RELEASED

Mar 25, 2024

V1.0

UAT

RELEASED

Mar 25, 2024

V1.0

PROD

RELEASED

Mar 25, 2024

V1.0

API Definition

Upload Document

Request Header

Name

Value

Authorization

Bearer {access_token}

Request Payload

Field

Type

Description

File

form

Mime types:

  • image/*

  • application/pdf

  • application/msword

  • application/vnd.openxmlformats-officedocument.wordprocessingml.document

  • application/vnd.ms-excel

  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

  • text/plain

Max size: 40MB

multipart/form

Response Header

Content-Type

application/json

Response Body

Field

Type

Description

Id

uuid

File unique identifier

Return file Id

Request

POST /public/v2/documents/devices

Request with cURL

curl --location '{url}/public/v2/documents/devices' \
--header 'Authorization: Bearer {access_token}' \
--form 'File=@"/C:/Users/Document.docx"'

Response

200 Success

{
  "Data": {
    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "Errors": [],
  "Meta": null,
  "StatusCode": 200,
  "Message": "Success"
}

404 Not Found

{
  "Data": null,
  "Errors": [],
  "Meta": null,
  "StatusCode": 404,
  "Message": "Not Found"
}

422 Unprocessable Entity

{
  "Data": null,
  "StatusCode": 422,
  "Errors": [],
  "Meta": null,
  "Message": "Unprocessable Entity"
}

401 Unauthorized

{
  "Data": null,
  "StatusCode": 401,
  "Errors": [],
  "Meta": null,
  "Message": "Unauthorized"
}
  • No labels