Resources
Create / Update Resource
새로운 리소스를 생성하거나 리소스 정보를 업데이트합니다.
Endpoint
POST {{baseUrl}}/resources
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 |
|---|---|---|---|
|
resourceID |
string |
mandatory |
리소스 고유 식별 값으로, 사용자 또는 디바이스 그룹의 ID |
|
venID |
string |
mandatory |
Virtual End Node의 고유 식별 값으로, 리소스 그룹의 ID |
|
comment |
string |
optional |
리소스 설명 |
Request Example
$ curl '{{baseUrl}}/resources' -i -X POST
-H 'Accept: application/json'
-H 'x-message-id: message-id'
-H 'x-service-id: 3rd-party-service-id'
-H 'x-service-token: 3rd-party-service-token'
-H 'x-country-code: us'
-d '{"resourceID":"lgeDR-CE-TV",
"venID": "LGE_DR",
"comment":"LGE TV DR system"
}
Response
Response Body
요청에 대한 응답으로, 응답 바디에 다음 정보가 JSON 포맷으로 반환됩니다.
|
Key |
Value |
|
|---|---|---|
|
code |
요청 처리에 대한 결과 코드 코드값에 대한 설명은 Common Response 페이지를 참조하십시오. |
|
|
data |
결과 코드에 해당하는 결과 데이터 |
|
|
resourceID |
리소스 ID |
|
Response Example
{
"code": 2000,
"data": {
"resourceID": "lgeDR-CE-TV"
}
}
Get Resource
특정 VEN의 리소스를 조회합니다.
Endpoint
GET {{baseUrl}}/resources/{ven-id}
Request
Path Parameter
식별값을 전달하기 위해 ven-id를 입력합니다.
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
ven-id |
string |
mandatory |
Virtual End Node의 ID로, 에너지 관리 시스템(EMS) 또는 최종 디바이스 그룹을 의미합니다. VEN ID는 이벤트(DR Request)가 발생하기 전에 미리 정의되어야 합니다. VEN ID 정의를 위해 LG DR 팀(cloud-sdt-dr@lge.com)으로 연락 주시기 바랍니다.
|
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 '{{baseUrl}}/resource/{ven-id}' -i -X GET
-H 'Accept: application/json'
-H 'x-message-id: message-id'
-H 'x-service-id: 3rd-party-service-id'
-H 'x-service-token: 3rd-party-service-token'
-H 'x-country-code: us'
Response
Response Body
요청에 대한 응답으로, 바디에 JSON 포맷으로 다음 정보가 반환됩니다.
|
Key |
Value |
|
|---|---|---|
|
code |
요청 처리에 대한 결과 코드 코드값에 대한 설명은 Common Response 페이지를 참조하십시오. |
|
|
data |
결과 코드에 해당하는 결과 데이터 |
|
|
resourceID |
LG DR 서비스에 등록된 해당 리소스 ID |
|
|
venID |
해당 VEN ID |
|
|
comment |
리소스 설명 |
|
|
insertTs |
리소스가 등록된 시간 (10 digits) |
|
Response Example
{
"code": 2000,
"data": [
{
"resourceID":"lgeDR-CE-TV",
"comment": "Electro - LGE TV DR system",
"venID: "LGE_DR",
"insertTs": "1234567890"
},
{
"resourceID":"lgeDR-ST-ESS",
"comment": "Stark- LGE ESS DR system",
"venID: "LGE_DR",
"insertTs": "1234567891"
},
{
"resourceID":"LgeDR-ST-AC",
"comment": "Stark - LGE Air Conditioner DR system",
"venID: "LGE_DR",
"insertTs": "1234567892"
}
]
}