Close

Data Delivery

Create Data ZIP File

디바이스의 상태 정보를 주기적으로 저장한 데이터를 ZIP 파일로 생성합니다.

Endpoint

POST {{baseUrl}}/data-zip/files​

 

Request

Path Parameter

N/A

 

Request Header

요청 헤더에 JSON 포맷으로 다음 정보를 입력합니다.

 

요청 헤더(공통 헤더) 정보

Name

Type

Required

Description

x-service-id

string

mandatory

요청을 보내는 서비스의 서비스 ID 값입니다.

x-service-token

string

mandatory

유효한 요청인지 확인하기 위한 서비스 Token 값입니다. 서비스 통합 전에 발행되어야 합니다.

x-message-id

string

optional

요청에 대한 처리를 추적하기 위한 값입니다. 

x-country-code

string

mandatory

서비스를 제공할 국가 코드입니다. ISO 국가 코드를 사용합니다. (예: KR, US, TW, CN, ......)

 

Request Body

요청 바디에 JSON 포맷으로 다음 정보를 입력합니다.

 

요청 바디 정보

Key

Type

Required

Description

target

string

mandatory

타깃 디바이스

  • x-DEVICE_TV
  • x-DEVICE_AIR_CONDITIONER

venID

string

mandatory

타깃 VEN ID (Virtual End Node ID)로, 에너지 관리 시스템(EMS) 또는 최종 디바이스(end device) 그룹을 의미합니다.

resourceIDs

string array

optional

타깃 리소스 ID로, 디바이스 타입 또는 최종 디바이스(end device) 그룹을 의미합니다.

from

number

mandatory

UTC 타임스탬프 (단위: 초)

  • 타깃 디바이스가 x-DEVICE_TV인 경우, 최대 하루까지 지정할 수 있습니다.
  • 타임스탬프는 LG DR 서비스 서버에서 자동으로 날짜로 변환됩니다.

to

number

mandatory

UTC 타임스탬프 (단위: 초)

  • 타깃 디바이스가 x-DEVICE_TV인 경우, 최대 하루까지 지정할 수 있습니다.
  • 타임스탬프는 LG DR 서비스 서버에서 자동으로 날짜로 변환됩니다.

 

Request Example

curl -v \ 
    -X POST \ 
    -H 'Content-Type: application/json' \ 
    -H 'x-service-id: bzc01pn243ch31' \ 
    -H 'x-service-token: a8e1236b9061123b77de5d61586e38e6' \ 
    -H 'x-message-id: p5dB3HOcSPSM8toOPxoBuz' \ 
    -H 'x-country-code: US' \ 
    {{baseUrl}}/data-zip/files \ 
    -d '{
        "target": "x-DEVICE_TV",
        "venID": "CE-01",
        "from" : 1546300800,
        "to": 1548979199
    }'

 

Response

Response Body

요청에 대한 응답으로, 응답 바디에 다음 정보가 JSON 포맷으로 반환됩니다.

 

응답 바디 정보

Key

Value

code

요청 처리에 대한 결과 코드

코드값에 대한 설명은 Common Response 페이지를 참조하십시오.

data

결과 코드에 해당하는 결과 데이터
 

taskId

ZIP 파일 생성 태스크 ID
 

fileName

ZIP 파일 이름

 

Response Example

{
    "code": 2000,
    "data": {
        "taskId": "9e7b7012-0730-427b-bf85-607d15abadb5",
        "fileName": "data-zip-1546300800-1548979199-1548892800.zip"
    }
}

 

Download a Data ZIP File

특정 ZIP 파일을 다운로드합니다. 

Endpoint

GET {{baseUrl}}/data-zip/files/{fileName}​

 

Request

Path Parameter

다운로드하고자 하는 ZIP 파일의 fileName을 입력합니다.

 

파라미터 정보

Name

Type

Required

Description

fileName

string

mandatory

ZIP 파일명

  • 형식: data-zip-{from}-{to}-{expireAt}.zip
  • E.g. data-zip-1548374400-1549843200-1548892800.zip

 

Request Header

요청 헤더에 JSON 포맷으로 다음 정보를 입력합니다.

 

요청 헤더(공통 헤더) 정보

Name

Type

Required

Description

x-service-id

string

mandatory

요청을 보내는 서비스의 서비스 ID 값입니다.

x-service-token

string

mandatory

유효한 요청인지 확인하기 위한 서비스 Token 값입니다. 서비스 통합 전에 발행되어야 합니다.

x-message-id

string

optional

요청에 대한 처리를 추적하기 위한 값입니다. 

x-country-code

string

mandatory

서비스를 제공할 국가 코드입니다. ISO 국가 코드를 사용합니다. (예: KR, US, TW, CN, ......)

 

Request Body

N/A

 

Request Example

curl -v \
    -X GET \
    -H 'Content-Type: applicatoin/json' \
    -H 'x-service-id: bzc01pn243ch31' \
    -H 'x-service-token: a8e1236b9061123b77de5d61586e38e6' \
    -H 'x-message-id: p5dB3HOcSPSM8toOPxoBuz' \
    -H 'x-country-code: US' \
    {{baseUrl}}/data-zip/files/data-zip-1546300800-1548979199-1548892800.zip \
    -o data-zip-1546300800-1548979199-1548892800.zip