1. APIリファレンス
  2. REST管理インタフェースAPIの使用
  3. 個別のRESTサービス

40.2 個別のRESTサービス

個別のRESTサービスには、次のサービスがあります。

親トピック: REST管理インタフェースAPIの使用

40.2.1 インスタンス・レベルの統計のフェッチ

このサービスは、Oracle Application Expressインスタンス全体に関する使用統計を戻します。

HTTPリクエスト構文のパラメータ

表40-2 HTTPリクエストの構文

パラメータ 説明

HTTPメソッド

GET

URL

http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/instance

HTTPリクエスト・ヘッダー

"authorization": "Bearer: OAuth access token aquired with Authentication

戻り値

{
    "items": [
        {
            "log_day": "2016-09-15T00:00:00Z",
            "workspace_id": 1809074264671554,
            "workspace_name": "SOMEWORKSPACE",
            "workspace_link": {
                "$ref": "http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/workspace/someworkspace"
            },
            "application_id": 4750,
            "application_name": "Oracle APEX Packaged Applications",
            "application_link": {

パラメータ

次のようにリクエストURLに問合せを追加すると、各JSON属性のフィルタリングも可能です。

http://application-express-host.../latest/instance?q=query

例

すべてのインスタンス統計を取得する

この例では、コマンドライン・ユーティリティcurlを実行すると、次の出力が表示されます。 

  $ curl -H"Authorization: Bearer LfXJilIBdzj5JPRn4xb5QQ..
          -i http://localhost:8081/ords/restauth/emp/list/ 
          http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/instance

この例では、他のApplication ExpressインスタンスでAPEX_WEB_SERVICEを使用したとき、次の出力が表示されます。

注意:

この例では、OAUTH_AUTHENTICATEプロシージャが成功していると仮定しています。 

   select apex_web_service.make_rest_request(
           p_url =>         'http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/instance'
           p_http_method => 'GET' )
   from dual;

JSONドキュメントの応答は次のとおりです。 

   {
       "items": [
           {
               "log_day": "2016-09-15T00:00:00Z",
               "workspace_id": 267781782378434879,
               "workspace_name": "SOMEWORKSPACE",
               "workspace_link": {
                   "$ref": "http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/workspace/someworkspace"

2016年8月1日以降のインスタンス統計を取得する

この例では、コマンドライン・ユーティリティcurlを実行すると、次の出力が表示されます。 

  $ curl -H"Authorization: Bearer LfXJilIBdzj5JPRn4xb5QQ..
          -i http://localhost:8081/ords/restauth/emp/list/ 
          http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/instance?q=%7B%22log_day%22:%7B%22$gt%22:%7B%22$date%22:%222016-08-01T00:00:00Z%22%7D%7D%7D

この例では、他のApplication ExpressインスタンスでAPEX_WEB_SERVICEを使用したとき、次の出力が表示されます。

注意:

この例では、OAUTH_AUTHENTICATEプロシージャが成功していると仮定しています。 

 select apex_web_service.make_rest_request(
           p_url =>         'http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/instance?q=' || 
                            utl_url.escape('{"log_day": {"$gt": {"$date": "2016-08-01T00:00:00Z"}}}'),
           p_http_method => 'GET',
           p_scheme =>      'OAUTH_CLIENT_CRED' )
   from dual;

JSONドキュメントの応答は次のとおりです。

  {
       "items": [
           {
               "log_day": "2016-09-15T00:00:00Z",
               "workspace_id": 267781782378434879,
               "workspace_name": "SOMEWORKSPACE",
               "workspace_link": {
                   "$ref": "http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/workspace/someworkspace"

参照:

問合せの作成方法の詳細は、Oracle REST Data Servicesインストレーション、構成および開発ガイドを参照してください。

親トピック: 個別のRESTサービス

40.2.2 ワークスペース・レベルの統計のフェッチ

このサービスは、特定のApplication Expressワークスペースに関する使用統計を戻します。

HTTPリクエスト構文のパラメータ

表40-3 HTTPリクエストの構文

パラメータ 説明

HTTPメソッド

GET

URL

http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/workspace/workspace-name

HTTPリクエスト・ヘッダー

"authorization": "Bearer: OAuth access token aquired with Authentication

戻り値

{
    "items": [
        {
            "log_day": "2016-09-15T00:00:00Z",
            "workspace_id": 1809919633676005,
            "application_id": 106,
            "application_name": "Sample Calendar",
            "application_link": {
                "$ref": "http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106"
            },
            "page_events": 94,
    :

パラメータ

次のようにリクエストURLに問合せを追加すると、各JSON属性のフィルタリングも可能です。

http://application-express-host.../latest/instance?q=query

例

ワークスペース「MYWORKSPACE」の全統計を取得する

この例では、コマンドライン・ユーティリティcurlを実行すると、次の出力が表示されます。 

   $ curl -H"Authorization: Bearer LfXJilIBdzj5JPRn4xb5QQ..
          -i http://localhost:8081/ords/restauth/emp/list/ 
          http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/workspace/myworkspace

この例では、他のApplication ExpressインスタンスでAPEX_WEB_SERVICEを使用したとき、次の出力が表示されます。

注意:

この例では、OAUTH_AUTHENTICATEプロシージャが成功していると仮定しています。 

   select apex_web_service.make_rest_request(
           p_url =>         'http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/workspace/myworkspace'
           p_http_method => 'GET',
           p_scheme =>      'OAUTH_CLIENT_CRED' )
   from dual;

JSONドキュメントの応答は次のとおりです。

   {
     "items": [
        {
           "log_day": "2016-09-15T00:00:00Z",
           "workspace_id": 1809919633676005,
           "application_id": 106,
           "application_name": "Sample Calendar",
           "application_link": {
              "$ref": "http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106"
           },
           "page_events": 94,
   :

2016年8月1日以降の「MYWORKSPACE」のワークスペース統計を取得する

この例では、コマンドライン・ユーティリティcurlを実行すると、次の出力が表示されます。 

   $ curl -H"Authorization: Bearer LfXJilIBdzj5JPRn4xb5QQ..
          -i http://localhost:8081/ords/restauth/emp/list/ 
          http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/workspace/myworkspace?q=%7B%22log_day%22:%7B%22$gt%22:%7B%22$date%22:%222016-08-01T00:00:00Z%22%7D%7D%7D

この例では、他のApplication ExpressインスタンスでAPEX_WEB_SERVICEを使用したとき、次の出力が表示されます。

注意:

この例では、OAUTH_AUTHENTICATEプロシージャが成功していると仮定しています。 

    select apex_web_service.make_rest_request(
           p_url =>      'http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/workspace/myworkspace?q='||
                          utl_url.escape(' "log_day": "$gt":"$date": "2016-08-01T00:00:00Z" '),
           p_http_method => 'GET' )
   from dual;

JSONドキュメントの応答は次のとおりです。

  {
     "items": [
        {
           "log_day": "2016-09-15T00:00:00Z",
           "workspace_id": 1809919633676005,
           "application_id": 106,
           "application_name": "Sample Calendar",
           "application_link": {
              "$ref": "http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106"
           },
           "page_events": 94,
   :

参照:

問合せの作成方法の詳細は、Oracle REST Data Servicesインストレーション、構成および開発ガイドを参照してください。

親トピック: 個別のRESTサービス

40.2.3 アプリケーション・レベルの統計

このサービスは、特定のアプリケーションに関する使用統計を戻します。

HTTPリクエスト構文のパラメータ

表40-4 HTTPリクエストの構文

パラメータ 説明

HTTPメソッド

GET

URL

http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/application-id

HTTPリクエスト・ヘッダー

"authorization": "Bearer: OAuth access token aquired with Authentication

戻り値

{
    "items": [
        {
            "log_day": "2016-09-15T00:00:00Z",
            "workspace_id": 1809919633676005,
            "application_id": 106,
            "application_name": "Sample Calendar",
            "application_link": {
                "$ref": "http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106"
            },
            "page_events": 94,
    :

パラメータ

次のようにリクエストURLに問合せを追加すると、各JSON属性のフィルタリングも可能です。

http://application-express-host.../stats/latest/application/application-id?q=query

例

アプリケーション「106」の全統計を取得する

この例では、コマンドライン・ユーティリティcurlを実行すると、次の出力が表示されます。 

   $ curl -H"Authorization: Bearer LfXJilIBdzj5JPRn4xb5QQ..
          -i http://localhost:8081/ords/restauth/emp/list/ 
          http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106

この例では、他のApplication ExpressインスタンスでAPEX_WEB_SERVICEを使用したとき、次の出力が表示されます。

注意:

この例では、OAUTH_AUTHENTICATEプロシージャが成功していると仮定しています。 

 select apex_web_service.make_rest_request(
           p_url =>         'http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106'
           p_http_method => 'GET',
           p_scheme =>      'OAUTH_CLIENT_CRED' )
   from dual;

JSONドキュメントの応答は次のとおりです。

  {
     "items": [
        {
           "log_day": "2016-09-15T00:00:00Z",
           "workspace_id": 1809919633676005,
           "application_id": 106,
           "application_name": "Sample Calendar",
           "application_link": {
              "$ref": "http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106"
           },
           "page_events": 94,
   :

2016年8月1日以降のアプリケーション「106」の統計を取得する

この例では、コマンドライン・ユーティリティcurlを実行すると、次の出力が表示されます。 

    $ curl -H"Authorization: Bearer LfXJilIBdzj5JPRn4xb5QQ..
          -i http://localhost:8081/ords/restauth/emp/list/ 
          http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106?q=%7B%22log_day%22:%7B%22$gt%22:%7B%22$date%22:%222016-08-01T00:00:00Z%22%7D%7D%7D

この例では、他のApplication ExpressインスタンスでAPEX_WEB_SERVICEを使用したとき、次の出力が表示されます。

注意:

この例では、OAUTH_AUTHENTICATEプロシージャが成功していると仮定しています。 

    select apex_web_service.make_rest_request(
           p_url =>         'http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106?q=' || 
                            utl_url.escape(' "log_day": "$gt": "$date": "2016-08-01T00:00:00Z" '),
           p_http_method => 'GET' )
   from dual;

JSONドキュメントの応答は次のとおりです。

  {
     "items": [
        {
           "log_day": "2016-09-15T00:00:00Z",
           "workspace_id": 1809919633676005,
           "application_id": 106,
           "application_name": "Sample Calendar",
           "application_link": {
              "$ref": "http://application-express-host:port/ords/apex_instance_admin_user/stats/latest/application/106"
           },
           "page_events": 94,
   :

参照:

問合せの作成方法の詳細は、Oracle REST Data Servicesインストレーション、構成および開発ガイドを参照してください。

親トピック: 個別のRESTサービス

40.2.4 インスタンスの概要

このサービスは、Application Expressインスタンスの集計概要データを戻します。

HTTPリクエスト構文のパラメータ

表40-5 HTTPリクエストの構文

パラメータ 説明

HTTPメソッド

GET

URL

http://application-express-host:port/ords/apex_instance_admin_user/info/latest/instance/number-of-days

HTTPリクエスト・ヘッダー

"authorization": "Bearer: OAuth access token aquired with Authentication

戻り値

{
    "items": [
        {
            "workspaces_total": 1074,
            "apps_total": 2827,
            "schemas_total": 1065,
            "reporting_timeframe_since": "2016-07-16T13:30:40Z",
            "reporting_timeframe_to": "2016-10-14T13:30:40Z",
            "active_apps_timeframe": 2827,
            "active_developers_timeframe": 731,
            "workspaces_timeframe": 1074
        }
    ],
    "first": {
        "$ref": "https://apexea.oracle.com/pls/apex/apex_instance_admin_user/info/latest/instance/90"
    }
}

パラメータ

number-of-days: 日数で指定した過去から本日までの集計値を戻します。

例

この例では、コマンドライン・ユーティリティcurlを実行すると、次の出力が表示されます。 

   $ curl -H"Authorization: Bearer LfXJilIBdzj5JPRn4xb5QQ..
          -i http://localhost:8081/ords/restauth/emp/list/ 
          http://application-express-host:port/ords/apex_instance_admin_user/info/latest/instance/90

この例では、他のApplication ExpressインスタンスでAPEX_WEB_SERVICEを使用したとき、次の出力が表示されます。

注意:

この例では、OAUTH_AUTHENTICATEプロシージャが成功していると仮定しています。 

   select apex_web_service.make_rest_request(
           p_url =>         'http://application-express-host:port/ords/apex_instance_admin_user/info/latest/instance/90',
           p_http_method => 'GET' )
   from dual;

JSONドキュメントの応答は次のとおりです。

{
    "items": [
        {
            "workspaces_total": 1074,
            "apps_total": 2827,
            "schemas_total": 1065,
            "reporting_timeframe_since": "2016-07-16T13:30:40Z",
            "reporting_timeframe_to": "2016-10-14T13:30:40Z",
            "active_apps_timeframe": 2827,
            "active_developers_timeframe": 731,
            "workspaces_timeframe": 1074
        }
    ],
    "first": {
        "$ref": "https://apexea.oracle.com/pls/apex/apex_instance_admin_user/info/latest/instance/90"
    }
}

親トピック: 個別のRESTサービス

40.2.5 RESTサービスのバージョン情報

このサービスは、REST管理インタフェースのバージョン情報を戻します。

HTTPリクエスト構文のパラメータ

表40-6 HTTPリクエストの構文

パラメータ 説明

HTTPメソッド

GET

URL

http://application-express-host:port/ords/apex_instance_admin_user/info/latest/

HTTPリクエスト・ヘッダー

"authorization": "Bearer: OAuth access token aquired with Authentication

戻り値

{
    "items": [
        {
            "version": "5.1.0"
        }
    ]
}

例

この例では、コマンドライン・ユーティリティcurlを実行すると、次の出力が表示されます。 

 $ curl -H"Authorization: Bearer LfXJilIBdzj5JPRn4xb5QQ..
          -i http://localhost:8081/ords/restauth/emp/list/ 
          http://application-express-host:port/ords/apex_instance_admin_user/info/rest-service-version

この例では、他のApplication ExpressインスタンスでAPEX_WEB_SERVICEを使用したとき、次の出力が表示されます。

注意:

この例では、OAUTH_AUTHENTICATEプロシージャが成功していると仮定しています。 

      select apex_web_service.make_rest_request(
           p_url =>         'http://application-express-host:port/ords/apex_instance_admin_user/info/latest/rest-service-version',
           p_http_method => 'GET' )
   from dual;

JSONドキュメントの応答は次のとおりです。

{
    "items": [
        {
            "version": "5.1.0"
        }
    ]
}

親トピック: 個別のRESTサービス