Skip to main content

12) 오피스 문서의 은닉정보 조회

오피스 문서의 은닉정보 조회

API

MethodURL
POST/api/get/internal/customProperties

Request Header

NameRequiredDescription
Authorizationrequired사용자 인증 수단, JWT값
Authorization: Bearer {JWT}
참고 : JWT값은 인증/인가 서비스를 통해 발급 받는다.

Request Body

NameRequiredTypeDescription
companyIdrequiredstring대상 문서서를 사용하는 회사ID
jsonObjrequiredjsonObject문서 정보
jsonObj
NameRequiredTypeDescription
filePathrequiredstring대상 문서 경로

Response

NameTypeDescription
codeint0 : 성공
이외의 값 : 에러
infojsonObject문서 정보
messagestring실패 시 에러 메시지
info
NameTypeDescription
filePathstring대상 문서 경로
propertiesjsonArray문서 은닉 정보 목록
    keystring은닉정보 key
    valuestring은닉정보 value

Examples

Request

  • Body
{
"companyId": "7FDKQsEK-QVGKyXA2-fx1LxIzy-SNIre0s9",
"jsonObj": "{\"filePath\":\"/opt/shieldrm/data/test/none.xlsx\"}"
}

Response

  • 성공
{
"code": 0,
"info": "{\"filePath\":\"/opt/shieldrm/data/test/none.xlsx\",\"properties\":[{\"value\":\"test1\",\"key\":\"key1\"},{\"value\":\"test2\",\"key\":\"key2\"}]}"
}
  • 실패
  • Status code : 200 OK
[지원하지 않는 확장자]
{
"code": -1,
"message": "Unsupported file type: /opt/shieldrm/data/test/none.txt"
}

[AIP 문서일 경우]
{
"code": -1,
"message": "Permission is required to open this file."
}
{
"code": -1,
"message": "Unknown file format."
}

[DS 문서일 경우]
{
"code": -1,
"message": "zip END header not found"
}
{
"code": -1,
"message": "Unsupported file format: Unknown"
}

  • Status code : 401 UNAUTHORIZED
{
"code": 40101,
"message": "Invalid token"
}