Cisco MediaSense 開発者ガイド リリース 11.0(1)
System Information
System Information

System Information

はじめに

これらの API を使用し、MediaSense API バージョン情報を取得します。 この API を使用するためにサインインする必要はありません。 getAPIVersion API は MediaSense 展開で実行されている API の浮動小数点バージョン番号を返します。

getAPIVersion

この API を使用し、システムで実行されている API の現在のバージョンを取得します。 バージョン番号は 1.0 から始まります。製品バージョンには関連しません。 バージョン番号は x.y.z ではなく、x.y です(たとえば、1.0.1 ではなく、1.0 です)。

URI

https://<host>:<port>/ora/infoService/info/getAPIVersion

HTTP メソッド

GET

パラメータ

apiVersion:出力文字列。 現在システムで動作している API のバージョン番号。 このバージョンは文字列として返されますが、浮動小数点数でもあります。 比較的小さな数値は、古いバージョンを示します。 比較的大きな数値は、新しいバージョンを示します。

HTTPS GET:

https://10.10.10.10:8440/ora/infoService/info/
getAPIVersion

応答:

{
    "responseMessage": "Success: Your request was successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "apiVersion": "1.4"
    }
}

getSystemTime

この API を使用し、システムの現在の時刻を取得します。 この時間は 1970 年 1 月 1 日 GMT 以降の秒数で返されます。

すべての MediaSense サーバが NTP クライアントとして設定されるため、サーバ間の違いが少ないことが求められます。 そのため、システム時刻が 1 つだけ返されます。この時間が MediaSense クラスタ内のすべてのサーバに適用されます。

URI

https://<host>:<port>/ora/infoService/info/getSystemTime

HTTP メソッド

GET

パラメータ

currentSystemTime:出力整数。 要求が処理されたシステム時刻(1970 年 1 月 1 日 GMT からの経過時間をミリ秒単位で表示)。

HTTPS GET:

https://10.194.118.72:8440/ora/infoService/info/
getSystemTime

ヘッダー:

JSESSIONID: <the jsessionId received from a signIn 
request>

応答:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "currentSystemTime": "1301145648258"
    }
}

getSessionsResponseSchema

この API を使用し、システムで実行されている getSessions 応答スキーマの現在のバージョンを取得します。


(注)  


スキーマの「required」タグは、親プロパティが実際の応答に入っていなければならないことを意味します。 「required」が指定されていない場合、または false に設定されている場合、そのプロパティは応答で返されないことがあります。

MediaSense は json スキーマのドラフトとは少し異なる方法で「searchable」を使用します。ノードは、可能な操作のアレイであるオブジェクトから構成されます。 「searchable」値が存在する場合、それに該当するプロパティを検索できます。 存在しないか、false に設定されている場合、そのプロパティは検索できません。

アレイはプロパティ(equals、greaterThan、lessThan、between など)を定義します。このプロパティでオブジェクトを検索できます。 between プロパティには lowerBound 値と upperBound 値があります。


URI

https://<host>:<port>/ora/infoService/info/getSessionsResponseSchema

HTTP メソッド

GET

パラメータ

なし

HTTPS GET:

https://10.10.10.10:8440/ora/infoService/info/
getSessionsResponseSchema

応答:

{
	"type":"object",
	"$schema": "http://json-schema.org/draft-03/schema",
	"apiVersion": "string representation of api version",
	"properties": 
   {"responseCode": 
     {"type":"number",
      "required":true },
		  "responseMessage": 
     {"type":"string",
      "required":true }
    "responseBody": 
     {"type":"object",
      "required":false
      "properties":
       {"sessions": 
         {"type":"array",
					     "required":true,
					     "items":
           {"type":"object",
            "required":true,
							     "properties":
             {"callControllerIP": 
               {"type":"string",
									       "required":true },
								      "callControllerType": 
               {"type":"string",
                "required":true },
								      "ccid": 
               {"type":"string",
									       "required":false,
                "searchable": 
                 {"operations": ["equals"] }
             },
								    "sessionDuration": 
             {"type":"number",
              "required":false,
              "minimum":0,
              "searchable": 
               {"operations": ["equals", "lessThan", 
                  "greaterThan"] }
             },
"sessionId": 
             {"type":"string",
									     "required":true },
								    "sessionStartDate": 
             {"type":"number",
									     "required":true,
              "minimum":0,
              "searchable": 
               {"operations": ["between"] }
             },
            "sessionState": 
             {"description":"string values are ACTIVE, 
               CLOSED_NORMAL, DELETED, and CLOSED_ERROR",
             "type":"string",
    									"required":true,
             "searchable": 
              {"operations": ["equals"] }
             },
	   							"tags": 
            {"type":"array",
             "required":false,
             "items": 
              {"type":"object",
               "required":true,
											    "properties":
                {"tagCreateDate": 
                  {"type":"number",
												       "required":true },
     												"tagName": 
                  {"type":"string",
													      "required":true,
                   "searchable": 
                    {"operations": ["equals", "contains", 
                       "startsWith", "endsWith"] }
                  },
   												  "tagOffset": 
                  {"type":"number",
											        "required":false },
     												"tagType": 
                  {"description":"string values are 
                    SYSTEM_DEFINED and USER_DEFINED",
                   "type":"string",
                   "required"true,
                   "searchable": 
                    {"operations": ["equals"] }
											        }
										       }
         						},
 "tracks": 
              {"type":"array",
									      "required":true,
									      "items":
                {"type":"object",
											      "required":true,
											      "properties":
                  {"codec": 
                    {"type":"string",
													        "required":true },
												       "downloadUrl": 
                    {"type":"string",
												         "required":false },
    												   "participants": 
                    {"type":"array",
     													   "required":true,
                     "items": 
                      {"type":"object",
     															   "required":true,
     															   "properties":
                         {"deviceId": 
                           {"type":"string",
							       										    "required":true },
      																    "deviceRef": 
                           {"type":"string",
																	           "required":true,
                            "searchable": 
                             {"operations": ["equals", 
                              "contains", "startsWith", 
                              "endsWith", "between"] }
                           },
                          "isConference": 
                            {"type":"boolean",
									         								   "required":true },
        																  "participantDuration": 
                            {"type":"number",
																             "required":false },
																          "participantStartDate": 
                            {"type":"number",
																	            "required":true },
																          "xRefCi": 
                            {"type":"string",
																	            "required":false,
                             "searchable": 
                               {"operations": ["equals"] }
                            }
															           }
														          }
												          },

												   "tags": 
                 {"type":"array",
                  "required":false,
													     "items": 
                   {"type":"object",
															     "required":true,
															     "properties":
                     {"tagCreateDate": 
                       {"type":"number",
																	       "required":true },
																      "tagName": 
                       {"type":"string",
																	       "required":true },
																      "tagOffset": 
                       {"type":"number",
																        "required":false },
																      "tagType": 
                       {"description":"string values are 
                        SYSTEM_DEFINED and USER_DEFINED", 
                        "type":"string",
                        "required":true, }
															    }
														   }
   												},
"trackDuration": 
             {"type":"number",
												  "required":false },
												"trackMediaType": 
             {"description":"string values are AUDIO and 
               VIDEO",
              "required":true,
              "type":"string" },
												"trackNumber": 
             {"type":"number",
              "required"true },
												"trackStartDate": 
             {"type":"number",
													 "required":true }
											}
									}
							},
					"urls": 
       {"type":"object",
        "required":false,
								"properties":
         {"mp4Url": 
           {"type":"string",
            "required":false },
										"rtspUrl": 
           {"type":"string",
            "required":false },
										"wavUrl": 
           {"type":"string",
            "required":false	}
									}
							}
					 }
				 }
			 }
		 }
		}
	}
}