DR Requests

Create DR Request

DR Request를 생성합니다.

Endpoint

POST {{baseUrl}}/requests

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 포맷으로 다음 정보를 입력합니다.

요청 바디 정보
Name		Type	Required	Description
requestID		string	mandatory	DR Request ID
name		string	optional	DR Request 이름
eventSignals (array)	signalID	string	mandatory (from OpenADR spec)	이벤트 시그널 ID
	signalName	string	mandatory (from OpenADR spec)	OpenADR 이벤트 이름 LG DR 서비스에서는 'SIMPLE'(Simple levels), 'LOAD_CONTROL'(level control with offset)를 사용합니다.
	signalType	string	mandatory (from OpenADR spec)	OpenADR 이벤트 시그널 LG DR 서비스에서는 'level'(DR program level), 'x-loadControlLevelOffset'(level control with offset)을 사용합니다.
	targets	string array	mandatory (from OpenADR spec)	타깃 디바이스 (x-DEVICE_TV, x-DEVICE_AIR_CONDITIONER)
	minTemp	number	optional	DR 목표 온도의 최소값 범위: 64℉ - 86℉ (minTemp <= maxTemp) 기본값: 64℉
	maxTemp	number	optional	DR 목표 온도의 최대값 범위: 64℉ - 86℉ (minTemp <= maxTemp) 기본값: 86℉
	tempOffset	number	optional	DR 목표 온도 변화량 범위: 4℉ - 16℉ 기본값: 4℉
	unit	string	optional	온도 단위 F: 화씨 C: 섭씨
eventTargets (array)	venID	string	mandatory (from OpenADR spec)	타깃 VEN ID (Virtual End Node ID)로, 에너지 관리 시스템(EMS) 또는 최종 디바이스(end device) 그룹을 의미합니다. VEN ID는 이벤트(DR Request)가 발생하기 전에 미리 정의되어야 합니다. VEN ID 정의를 위해 LG DR 팀(cloud-sdt-dr@lge.com)으로 연락 주시기 바랍니다.
eventTargets (array)	resourceIDs	string array	optional (from OpenADR spec)	타깃 리소스 ID로, 디바이스 유형 또는 최종 디바이스(end device) 그룹을 의미합니다. 리소스ID는 이벤트(DR Request)가 발생하기 전에 미리 정의되어야 합니다. 리소스ID 정의를 위해 LG DR 팀(cloud-sdt-dr@lge.com)으로 연락 주시기 바랍니다.
vtnID		string	mandatory (from OpenADR spec)	VTN ID (Virtual Top Node ID)로, Aggregation Server 또는 Utility Server의 ID를 의미합니다. VTN ID는 이벤트(DR Request)가 발생하기 전에 미리 정의되어야 합니다. VTN ID 정의를 위해 LG DR 팀(cloud-sdt-dr@lge.com)으로 연락 주시기 바랍니다.
startTs		number	mandatory	DR 시작 시간 UTC timestamp 값 (13 digits) 단위: millisecond
endTs		number	mandatory	DR 종료 시간 UTC timestamp 값 (13 digits) 단위: millisecond

minTemp와 maxTemp의 값이 같은 경우, 목표 온도는 minTemp 값으로 설정됩니다. 이때 tempOffset 값은 무시됩니다.

Request Example

$ curl '{{baseUrl}}/requests' -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 '{
        "requestID": "2020-10-15-dr",
        "name": "first event",
        "startTs": 1234567890123,
        "endTs": 1234567890123,
        "eventSignals": [
            {
                "signalID": "2020-09-25-dr-event-01-signal-01",
                "signalName": "SIMPLE",
                "signalType": "level",
                "targets": [ "x-DEVICE_TV", "x-DEVICE_ESS" ]
            },
            {
                "signalID": "2020-09-25-dr-event-01-signal-02",
                "signalName": "LOAD_CONTROL",
                "signalType": "x-LoadControlLevelOffset",
                "targets": [ "x-DEVICE_AIR_CONDITIONER" ]
                "maxTemp": 86,
                "tempOffset": 6
            }
        ],
        "eventTargets":[
            {
                "venID": "CE-01",
                "resourceIDs": ["CE-TV", "CE-ESS"],
            },
            {
                "venID": "CE-02",
            }
        ],
    "vtnID": "vtn01"
}

Response

Response Body

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

응답 바디 정보
Key		Value
code		요청 처리에 대한 결과 코드 코드값에 대한 설명은 Common Response 페이지를 참조하십시오.
data		결과 코드에 해당하는 결과 데이터
	requestID	DR Request ID

Response Example

{
    "code": 2000,
    "data": {
        "requestID": "2020-10-15-dr"
    }
}

Delete DR Request

특정 DR Request를 삭제합니다. DR Request의 상태가 pending (status: 0)인 경우에만 삭제할 수 있습니다.

Endpoint

DELETE {{baseUrl}}/requests/{dr-id}

Request

Path Parameter

DR Request 식별값을 전달하기 위해 dr-id를 입력합니다.

파라미터 정보
Name	Type	Required	Description
dr-id	string	mandatory	DR Request ID

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}}/requests/{dr-id}' -i -X DELETE
    -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		결과 코드에 해당하는 결과 데이터
	id	DR Request ID

Response Example

{
    "code": 2000,
    "data": {
        "id": "2020-10-15-dr"
    }
}

Get DR Request

특정 DR Request의 정보를 조회합니다.

Endpoint

GET {{baseUrl}}/requests/{dr-id}

Request

Path Parameter

DR Request 식별값을 전달하기 위해 dr-id를 입력합니다.

파라미터 정보
Name	Type	Required	Description
dr-id	string	mandatory	DR Request ID

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}}/requests/{dr-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			결과 코드에 해당하는 결과 데이터
	requestID		DR Request ID
	name		DR Request 이름
	eventSignal		-
		signalID	이벤트 시그널 ID
		signalName	OpenADR 이벤트 이름 LG DR 서비스에서는 'SIMPLE'(Simple levels), 'LOAD_CONTROL'(level control with offset)을 사용합니다.
		signalType	OpenADR 이벤트 시그널 LG DR 서비스에서는 'level'(DR program level), 'x-loadControlLevelOffset'(level control with offset)을 사용합니다.
		targets	타깃 디바이스
		minTemp	DR 목표 온도의 최소값
		maxTemp	DR 목표 온도의 최대값
		tempOffset	DR 목표 온도 변화량
		unit	온도 단위 F: 화씨 C: 섭씨
	eventTargets		-
		venID	타깃 VEN ID (Virtual End Node ID) 에너지 관리 시스템(EMS) 또는 최종 디바이스 그룹을 의미합니다. DR Request 발생 전에 VTN 및 VEN 정보를 등록 할 때 미리 정의된 ID입니다.
		resourceIDs	타깃 리소스 ID 디바이스 타입 또는 최종 디바이스 그룹을 의미합니다. DR Request 발생 전에 VTN 및 VEN 정보를 등록 할 때 미리 정의된 ID입니다.
	vtnID		VTN ID (Virtual Top Node ID) Aggregation Server 또는 Utility Server의 ID입니다. DR Request 발생 전에 VTN 및 VEN 정보를 등록 할 때 미리 정의된 ID입니다.
	startTs		DR 시작 시간 (timestamp)
	endTs		DR 종료 시간 (timestamp)
	status		DR Request의 상태 0: pending 1: standby (notification 발송) 2: active 3: completed 9: canceled
	insertTs		DR Request 생성 시간 (10 digits)

Response Example

{ 
    "code": 2000,
    "data": {
        "requestID": "2020-10-15-dr", 
        "name": "first event", 
        "startTs": 1234567890123, 
        "endTs": 1234567890123, 
        "eventSignals": [ 
            {
                "signalID": "2020-09-25-dr-event-01-signal-01", 
                "signalName": "SIMPLE", 
                "targets": ["x-DEVICE_TV"]
            }
        ],
        "eventTargets": { 
                "venID": ["ven-02"],
                "resourceIDs" : [],
        },
        "vtnID": "vtn01",
        "status": "1",
        "insertTs": 1573112603404
        }
}

[Action Required: Windows XP OS users] End of Support for 3DES Cipher

DR Requests

Create DR Request

Endpoint

Request

Path Parameter

Request Header

Request Body

Request Example

Response

Response Body

Response Example

Delete DR Request

Endpoint

Request

Path Parameter

Request Header

Request Body

Request Example

Response

Response Body

Response Example

Get DR Request

Endpoint

Request

Path Parameter

Request Header

Request Body

Request Example

Response

Response Body

Response Example