Web of Things (WoT) プロファイル

Property 값을 읽을 때 사용할 property 리소스의 URL은 Thing Description에서 해당 PropertyAffordance 내부의 다음 조건을 만족하는 Form을 찾아 얻어야 MUST 합니다:

• 기본값이 적용된 후, 그 op 멤버가 readproperty 값을 포함합니다
• 해당되는 경우 base URL을 기준으로 확인된 후, 그 href 멤버 값의 URI scheme [RFC3986]이 http 또는 https입니다
• 기본값이 적용된 후, 그 contentType 멤버의 값이 application/json입니다

Property 값을 읽으려면, Consumer는 다음과 같은 HTTP 요청을 Web Thing에 보내야 MUST 합니다:

• 메서드는 GET으로 설정
• URL은 property 리소스의 URL로 설정
• Accept 헤더는 application/json으로 설정

Web Thing이 위 형식을 따르는 HTTP 요청을 수신하고, Consumer가 해당 Property를 읽을 권한이 있으면, Property 값을 성공적으로 읽은 후 다음과 같은 HTTP 응답을 보내야 MUST 합니다:

• 상태 코드는 200으로 설정
• Content-Type 헤더는 application/json으로 설정
• JSON으로 직렬화된 property 값을 포함하는 본문

Property 값을 쓸 때 사용할 property 리소스의 URL은 Thing Description에서 해당 PropertyAffordance 내부의 다음 조건을 만족하는 Form을 찾아 얻어야 MUST 합니다:

• 기본값이 적용된 후, 그 op 멤버가 writeproperty 값을 포함합니다
• 해당되는 경우 base URL을 기준으로 확인된 후, 그 href 멤버 값의 URI scheme [RFC3986]이 http 또는 https입니다
• 기본값이 적용된 후, 그 contentType 멤버의 값이 application/json입니다

Property 값을 쓰려면, Consumer는 다음과 같은 HTTP 요청을 Web Thing에 보내야 MUST 합니다:

• 메서드는 PUT으로 설정
• URL은 property 리소스의 URL로 설정
• Content-Type 헤더는 application/json으로 설정
• JSON으로 직렬화된 property의 요청된 새 값을 포함하는 본문

Web Thing이 위 형식을 따르는 HTTP 요청을 수신하고, Consumer가 해당 Property를 쓸 권한이 있으면, property 값을 성공적으로 쓴 후 다음과 같은 HTTP 응답을 보내야 MUST 합니다:

• 상태 코드는 204로 설정

모든 Properties 값을 한 번에 읽을 때 사용할 properties 리소스의 URL은 Thing Description에서 최상위 forms 멤버 내부의 다음 조건을 만족하는 Form을 찾아 얻어야 MUST 합니다:

• 그 op 멤버가 readallproperties 값을 포함합니다
• 해당되는 경우 base URL을 기준으로 확인된 후, 그 href 멤버 값의 URI scheme [RFC3986]이 http 또는 https입니다
• 기본값이 적용된 후, 그 contentType 멤버의 값이 application/json입니다

모든 Properties 값을 읽으려면, Consumer는 다음과 같은 HTTP 요청을 Web Thing에 보내야 MUST 합니다:

• 메서드는 GET으로 설정
• URL은 properties 리소스의 URL로 설정
• Accept 헤더는 application/json으로 설정

Web Thing이 위 형식을 따르는 HTTP 요청을 수신하면, Consumer가 접근 권한을 가진 모든 읽기 가능한 Properties 값을 성공적으로 읽은 후, 다음과 같은 HTTP 응답을 보내야 MUST 합니다:

• 상태 코드는 200으로 설정
• Content-Type 헤더는 application/json으로 설정
• 모든 읽기 가능한 properties의 값을 property 이름을 키로 하는 객체로 JSON 직렬화한 본문

여러 Properties 값을 한 번에 쓸 때 사용할 properties 리소스의 URL은 Thing Description에서 최상위 forms 멤버 내부의 다음 조건을 만족하는 Form을 찾아 얻어야 MUST 합니다:

• 그 op 멤버가 writemultipleproperties 값을 포함합니다
• 해당되는 경우 base URL을 기준으로 확인된 후, 그 href 멤버 값의 URI scheme [RFC3986]이 http 또는 https입니다
• 기본값이 적용된 후, 그 contentType 멤버의 값이 application/json입니다

여러 properties 값을 한 번에 쓰려면, Consumer는 다음과 같은 HTTP 요청을 Web Thing에 보내야 MUST 합니다:

• 메서드는 PUT으로 설정
• URL은 Properties 리소스의 URL로 설정
• Content-Type 헤더는 application/json으로 설정
• 쓰기 가능한 Properties의 요청된 새 값을 property 이름을 키로 하는 객체로 JSON 직렬화한 본문

Web Thing이 위 형식을 따르는 HTTP 요청을 수신하면, 요청된 쓰기 가능한 Properties 값을 성공적으로 쓴 후 다음과 같은 HTTP 응답을 보내야 MUST 합니다:

• 상태 코드는 204로 설정

Action을 호출할 때 사용할 action 리소스의 URL은 Thing Description에서 해당 ActionAffordance 내부의 다음 조건을 만족하는 Form을 찾아 얻어야 MUST 합니다:

• 기본값이 적용된 후, 그 op 멤버의 값이 invokeaction입니다
• 해당되는 경우 base URL을 기준으로 확인된 후, 그 href 멤버 값의 URI scheme [RFC3986]이 http 또는 https입니다
• 기본값이 적용된 후, 그 contentType 멤버의 값이 application/json입니다

Web Thing에서 Action을 호출하려면, Consumer는 다음과 같은 HTTP 요청을 Web Thing에 보내야 MUST 합니다:

• 메서드는 POST로 설정
• URL은 action 리소스의 URL로 설정
• Accept 헤더는 application/json으로 설정
• Content-Type 헤더는 application/json으로 설정(action에 입력이 있는 경우에만)
• 있는 경우 action에 대한 입력을 JSON으로 직렬화한 본문

Web Thing이 위 형식을 따르는 HTTP 요청을 수신하면 세 가지 응답 형식 중 하나로 응답해야 MUST 합니다:

1. 동기식 액션 응답
2. 비동기식 액션 응답
3. 오류 응답

action 요청의 상태를 질의하려면, Consumer는 다음과 같은 HTTP 요청을 Web Thing에 보내야 MUST 합니다:

• 메서드는 GET으로 설정
• URL은 ActionStatus 리소스의 URL로 설정
• Accept 헤더는 application/json으로 설정

Web Thing이 위 형식을 따르는 HTTP 요청을 수신하고, Consumer가 해당 ActionStatus 리소스를 질의할 권한이 있으면, action 요청의 상태를 성공적으로 읽은 후 다음과 같은 HTTP 응답을 보내야 MUST 합니다:

• 상태 코드는 200으로 설정
• Content-Type 헤더는 application/json으로 설정
• action 요청의 현재 상태를 나타내는 ActionStatus 객체를 JSON 직렬화하여 포함하는 본문

action 요청을 취소하려면, Consumer는 다음과 같은 HTTP 요청을 Web Thing에 보내야 MUST 합니다:

• 메서드는 DELETE로 설정
• URL은 ActionStatus 리소스의 URL로 설정

Web Thing이 위 형식을 따르는 HTTP 요청을 수신하고, Consumer가 해당 action 요청을 취소할 권한이 있으면, action을 성공적으로 취소한 후 다음과 같은 HTTP 응답을 보내야 MUST 합니다:

• 상태 코드는 204로 설정

진행 중인 모든 action 요청의 상태를 질의할 때 사용할 actions 리소스의 URL은 Thing Description에서 최상위 forms 멤버 내부의 다음 조건을 만족하는 Form을 찾아 얻어야 MUST 합니다:

• 그 op 멤버가 queryallactions 값을 포함합니다
• 해당되는 경우 base URL을 기준으로 확인된 후, 그 href 멤버 값의 URI scheme [RFC3986]이 http 또는 https입니다
• 기본값이 적용된 후, 그 contentType 멤버의 값이 application/json입니다

진행 중인 모든 action 요청의 상태를 질의하려면, Consumer는 다음과 같은 HTTP 요청을 Web Thing에 보내야 MUST 합니다:

• 메서드는 GET으로 설정
• URL은 actions 리소스의 URL로 설정
• Accept 헤더는 application/json으로 설정

Web Thing이 위 형식을 따르는 HTTP 요청을 수신하면, Consumer가 접근 권한을 가진 진행 중인 모든 action 요청의 상태를 성공적으로 검색한 후, 다음과 같은 HTTP 응답을 보내야 MUST 합니다:

• 상태 코드는 200으로 설정
• Content-Type 헤더는 application/json으로 설정
• Action 이름을 키로 하는 객체를 포함하는 본문으로, 각 객체 멤버의 값은 action 요청을 나타내는 ActionStatus 객체들의 배열이며, JSON으로 직렬화됩니다.

property の値を監視する際に使用する Property リソースの URL は、 対応する PropertyAffordance 内で、次を満たす Form を特定することにより、Thing Description から取得しなければならない（MUST）。

• その op メンバーが値 observeproperty を含むこと
• 該当する場合に基底 URL に対して解決された後、 その href メンバーの値の URI scheme [RFC3986] が http または https であること
• その subprotocol メンバーが sse の値を持つこと
• デフォルトが適用された後、その contentType メンバーの値が application/json であること

Web Thing のすべての properties への変更を監視する際に使用する properties リソースの URL は、 Thing Description の最上位の forms メンバー内で、次を満たす Form を特定することにより、 Thing Description から取得しなければならない（MUST）。

• その op メンバーが値 observeallproperties を含むこと
• 該当する場合に基底 URL に対して解決された後、 その href メンバーの値の URI scheme [RFC3986] が http または https であること
• その subprotocol メンバーが sse の値を持つこと
• デフォルトが適用された後、その contentType メンバーの値が application/json であること

Event を購読する際に使用する event リソースの URL は、 対応する EventAffordance 内で、次を満たす Form を特定することにより、 Thing Description から取得しなければならない（MUST）。

• デフォルトが適用された後、その op メンバーが値 subscribeevent を含むこと
• 該当する場合に基底 URL に対して解決された後、 その href メンバーの値の URI scheme [RFC3986] が http または https であること
• その subprotocol メンバーが sse の値を持つこと
• デフォルトが適用された後、その contentType メンバーの値が application/json であること

Web Thing により発行されるすべての Events を購読する際に使用する events リソースの URL は、 Thing Description の最上位の forms メンバー内で、次を満たす Form を特定することにより、 Thing Description から取得しなければならない（MUST）。

• その op メンバーが値 subscribeallevents を含むこと
• 該当する場合に基底 URL に対して解決された後、 その href メンバーの値の URI scheme [RFC3986] が http または https であること
• その subprotocol メンバーが sse の値を持つこと
• デフォルトが適用された後、その contentType メンバーの値が application/json であること

Property の値を監視する際に使用する property リソースの URL は、 対応する PropertyAffordance 内で、次を満たす Form を特定することにより、Thing Description [wot-thing-description11] から取得しなければならない（MUST）。

• その op メンバーが値 observeproperty を含むこと
• 該当する場合に基底 URL に対して解決された後、 その href メンバーの値の URI scheme [RFC3986] が http または https であること
• デフォルトが適用された後、その contentType メンバーが application/json の値を持つこと
• その subprotocol メンバーが webhook の値を持つこと

Property を監視するために、 Consumer は、 Web Thing に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを POST に設定する
• URL を property リソースの URL に設定する
• Content-Type ヘッダーを application/json に設定する
• 次のメンバーを持つ JSON オブジェクトを含む本文:
  • callbackURL メンバーを、 Thing が property 変更通知を Consumer に送信するために使用すべき コールバック URL に設定する。

Web Thing が上記の形式に従う HTTP リクエストを受信し、 Consumer が対応する Property を監視する権限を持つ場合、 コールバック URL を正常に登録したならば、 Consumer に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 201 Created に設定する
• Location ヘッダーを、 個別の property 監視サブスクリプションを表す一意の URL に設定する。 これは、後で Consumer が Property の監視をキャンセルする際に使用する。

property 監視サブスクリプションが登録されている間、 監視対象の Property の値に変更が発生するたびに、 Web Thing は、監視している Consumer に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを POST に設定する
• URL を、監視を登録する際に Consumer が提供した コールバック URL に設定する
• Content-Type ヘッダーを application/json に設定する
• 対応する property リソースの URL を URL として設定し、 rel を self に設定した Link ヘッダー
• ユーザーエージェントにより property 変更の時刻に自動的に設定される Date ヘッダー。 [rfc9110] の HTTP Date 形式を使用する
• 新しい Property の値を含む本文。 JSON でシリアライズされ、 Property Affordance のデータスキーマに適合する

Consumer が、有効な コールバック URL に対して上記の形式に従う HTTP リクエストを受信した場合、 Web Thing に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 200 OK に設定する

property の監視サブスクリプションをキャンセルするために、 Consumer は、 Web Thing に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを DELETE に設定する
• URL を、 observeproperty 操作中の HTTP レスポンスの Location ヘッダーで提供された subscription URL に設定する

Web Thing が上記の形式に従う HTTP リクエストを受信し、 提供された URL を持つ property 監視サブスクリプションが存在する場合、 サブスクリプションを正常にキャンセルしたならば、 Consumer に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 204 No Content に設定する

Web Thing のすべての Properties の値を監視する際に使用する properties リソースの URL は、 Thing Description の最上位の forms メンバー内で、次を満たす Form を特定することにより、 Thing Description [wot-thing-description11] から取得しなければならない（MUST）。

• その op メンバーが値 observeallproperties を含むこと
• 該当する場合に基底 URL に対して解決された後、 その href メンバーの値の URI scheme [RFC3986] が http または https であること
• デフォルトが適用された後、その contentType メンバーが application/json の値を持つこと
• その subprotocol メンバーが webhook の値を持つこと

Web Thing のすべての Properties への変更を監視するために、 Consumer は、 Web Thing に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを POST に設定する
• URL を properties リソースの URL に設定する
• Content-Type ヘッダーを application/json に設定する
• 次のメンバーを持つ JSON オブジェクトを含む本文:
  • callbackURL メンバーを、 Thing が property 変更通知を Consumer に送信するために使用すべき コールバック URL に設定する。

Web Thing が上記の形式に従う HTTP リクエストを受信し、 Consumer が Thing の Properties を監視する権限を持つ場合、 コールバック URL を正常に登録したならば、 Consumer に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 201 Created に設定する
• Location ヘッダーを、 個別の監視サブスクリプションを表す一意の URL に設定する。 これは、後で Consumer が すべての Properties の監視をキャンセルする際に使用する。

properties 監視サブスクリプションが登録されている間、 監視可能な任意の Property の値に変更が発生するたびに、 Web Thing は、監視している Consumer に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを POST に設定する
• URL を、監視サブスクリプションを登録する際に Consumer が提供した コールバック URL に設定する
• Content-Type ヘッダーを application/json に設定する
• 対応する PropertyAffordance の URL を URL として設定し、 rel を self に設定した Link ヘッダー
• ユーザーエージェントにより property 変更の時刻に自動的に設定される Date ヘッダー。 [rfc9110] の HTTP Date 形式を使用する
• 新しい Property の値を含む本文。 JSON でシリアライズされ、 PropertyAffordance のデータスキーマに適合する

Consumer が、有効な コールバック URL に対して上記の形式に従う HTTP リクエストを受信した場合、 Web Thing に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 200 OK に設定する

すべての Properties の監視をキャンセルするために、 Consumer は、 Web Thing に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを DELETE に設定する
• URL を、 observeallproperties 操作中の HTTP レスポンスの Location ヘッダーで提供された subscription URL に設定する

Web Thing が上記の形式に従う HTTP リクエストを受信し、 提供された URL を持つ properties 監視サブスクリプションが存在する場合、 監視サブスクリプションを正常にキャンセルしたならば、 Consumer に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 204 No Content に設定する

Event を購読する際に使用する event リソースの URL は、 対応する EventAffordance 内で、次を満たす Form を特定することにより、Thing Description [wot-thing-description11] から取得しなければならない（MUST）。

• その op メンバーが値 subscribeevent を含むこと
• 該当する場合に基底 URL に対して解決された後、 その href メンバーの値の URI scheme [RFC3986] が http または https であること
• デフォルトが適用された後、その contentType メンバーが application/json の値を持つこと
• その subprotocol メンバーが webhook の値を持つこと

Event を購読するために、 Consumer は、 Web Thing に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを POST に設定する
• URL を event リソースの URL に設定する
• Content-Type ヘッダーを application/json に設定する
• 次のメンバーを持つ JSON オブジェクトを含む本文:
  • callbackURL メンバーを、 Thing が event 通知を Consumer に送信するために使用すべき コールバック URL に設定する。

Web Thing が上記の形式に従う HTTP リクエストを受信し、 Consumer が対応する Event を購読する権限を持つ場合、 コールバック URL を正常に登録したならば、 Consumer に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 201 Created に設定する
• Location ヘッダーを、 個別の event サブスクリプションを表す一意の URL に設定する。 これは、後で Consumer がサブスクリプションを キャンセルする際に使用する。

event サブスクリプションが登録されている間、 監視対象の Event のインスタンスが発生するたびに、 Web Thing は、購読している Consumer に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを POST に設定する
• URL を、 Consumer が Event を購読する際に提供した コールバック URL に設定する
• Content-Type ヘッダーを application/json に設定する（event に データペイロードがある場合のみ）
• 対応する event リソースの URL を URL として設定し、 rel を self に設定した Link ヘッダー
• ユーザーエージェントにより event が発生した時刻に自動的に設定される Date ヘッダー。 [rfc9110] の HTTP Date 形式を使用する
• event のデータペイロード（存在する場合）を含む本文。 JSON でシリアライズされ、 EventAffordance のデータスキーマに適合する

Consumer が、有効な コールバック URL に対して上記の形式に従う HTTP リクエストを受信した場合、 Web Thing に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 200 OK に設定する

Event へのサブスクリプションをキャンセルするために、 Consumer は、 Web Thing に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを DELETE に設定する
• URL を、 subscribeevent 操作中の HTTP レスポンスの Location ヘッダーで提供された subscription URL に設定する

Web Thing が上記の形式に従う HTTP リクエストを受信し、 提供された URL を持つ event サブスクリプションが存在する場合、 サブスクリプションを正常にキャンセルしたならば、 Consumer に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 204 No Content に設定する

Web Thing のすべての Events を購読する際に使用する events リソースの URL は、 Thing Description の最上位の forms メンバー内で、次を満たす Form を特定することにより、 Thing Description [wot-thing-description11] から取得しなければならない（MUST）。

• その op メンバーが値 subscribeallevents を含むこと
• 該当する場合に基底 URL に対して解決された後、 その href メンバーの値の URI scheme [RFC3986] が http または https であること
• デフォルトが適用された後、その contentType メンバーが application/json の値を持つこと
• その subprotocol メンバーが webhook の値を持つこと

Web Thing のすべての Events を購読するために、 Consumer は、 Web Thing に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを POST に設定する
• URL を events リソースの URL に設定する
• Content-Type ヘッダーを application/json に設定する
• 次のメンバーを持つ JSON オブジェクトを含む本文:
  • callbackURL メンバーを、 Thing が event 通知を Consumer に送信するために使用すべき コールバック URL に設定する。

Web Thing が上記の形式に従う HTTP リクエストを受信し、 Consumer が Thing の Events を購読する権限を持つ場合、 コールバック URL を正常に登録したならば、 Consumer に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 201 Created に設定する
• Location ヘッダーを、 個別の event サブスクリプションを表す一意の URL に設定する。 これは、後で Consumer がサブスクリプションを キャンセルする際に使用する。

events サブスクリプションが登録されている間、 event が発生するたびに、Web Thing は、購読している Consumer に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを POST に設定する
• URL を、 サブスクリプションを登録する際に Consumer が提供した コールバック URL に設定する
• Content-Type ヘッダーを application/json に設定する（event が データペイロードを含む場合のみ）
• 対応する event リソースの URL を URL として設定し、 rel を self に設定した Link ヘッダー
• ユーザーエージェントにより event が発生した時刻に自動的に設定される Date ヘッダー。 [rfc9110] の HTTP Date 形式を使用する
• event データペイロード（存在する場合）を含む本文。 JSON でシリアライズされ、 EventAffordance のデータスキーマに適合する

Consumer が、有効な コールバック URL に対して上記の形式に従う HTTP リクエストを受信した場合、 Web Thing に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 200 OK に設定する

すべての Events へのサブスクリプションをキャンセルするために、 Consumer は、 Web Thing に対して、次を含む HTTP リクエストを送信しなければならない（MUST）。

• メソッドを DELETE に設定する
• URL を、 subscribeallevents 操作中の HTTP レスポンスの Location ヘッダーで提供された subscription URL に設定する

Web Thing が上記の形式に従う HTTP リクエストを受信し、 提供された URL を持つ events サブスクリプションが存在する場合、 events サブスクリプションを正常にキャンセルしたならば、 Consumer に対して、次を含む HTTP レスポンスを送信しなければならない（MUST）。

• ステータスコードを 204 No Content に設定する