PAR URLを使用したデータへのアクセス
PAR URLデータは、JSON形式で取得および返され、ページ区切りされます。
PAR URLデータには、ブラウザまたは任意のRESTクライアントを使用してアクセスできます。返されるデータは、一度に最大100レコードにアクセスできるようにページ区切りで、レスポンスの合計データ・サイズは1MBに制限されます。limit
問合せパラメータを指定して、フェッチされるレコード数を制限できます。PAR URL認証が失敗した場合、またはリクエストされたPAR URLの有効期限が切れている場合、PAR URLデータの取得はブロックされます。
たとえば、PAR URLを使用します。
curl https://dataaccess.adb.us-chicago-1.oraclecloudapps.com/adb/p/K6XExample/data
データに複数のページが含まれる場合、PAR URLレスポンスには、前または次のページのリンクが含まれます。これにより、データのフェッチ中にどちらの方向にもナビゲートできます。JSONには、現在のページを指すself
リンクと、フェッチできるデータがさらにあるかどうかを示すhasMore
属性も含まれています。
レスポンス形式は次のとおりです。
{
"items": [], <-- Array of records from database
"hasMore": true OR false, <-- Indicates if there are more records to fetch or not
"limit": Number, <-- Indicates number of records in the page. Maximum allowed number is 100.
"offset": Number, <-- Offset indicating the start of the current page
"count": Number, <-- Count of records in the current page
"links": [
{
"rel": "self",
"href": "{Link to preauth url for the current page}"
},
{
"rel": "previous",
"href": "{Link to preauth url for the previous page}"
},
{
"rel": "next",
"href": "{Link to preauth url for the next page}"
}
]
}
たとえば、PAR URLからのサンプル・レスポンスを次に示します(わかりやすくするために改行が追加されています)。
{"items":[
{"COUNTY":"Main","SPECIES":"Alder","HEIGHT":45},
{"COUNTY":"First","SPECIES":"Chestnut","HEIGHT":51},{"COUNTY":"Main","SPECIES":"Hemlock","HEIGHT":17},
{"COUNTY":"Main","SPECIES":"Douglas-fir","HEIGHT":34},{"COUNTY":"First","SPECIES":"Larch","HEIGHT":12},
{"COUNTY":"Main","SPECIES":"Cedar","HEIGHT":21},{"COUNTY":"First","SPECIES":"Douglas-fir","HEIGHT":10},
{"COUNTY":"Main","SPECIES":"Yew","HEIGHT":11},{"COUNTY":"First","SPECIES":"Willow","HEIGHT":17},
{"COUNTY":"Main","SPECIES":"Pine","HEIGHT":29},{"COUNTY":"First","SPECIES":"Pine","HEIGHT":16},
{"COUNTY":"First","SPECIES":"Spruce","HEIGHT":6},{"COUNTY":"Main","SPECIES":"Spruce","HEIGHT":8},
{"COUNTY":"First","SPECIES":"Hawthorn","HEIGHT":19},{"COUNTY":"First","SPECIES":"Maple","HEIGHT":16},
{"COUNTY":"Main","SPECIES":"Aspen","HEIGHT":35},{"COUNTY":"First","SPECIES":"Larch","HEIGHT":27},
{"COUNTY":"First","SPECIES":"Cherry","HEIGHT":20},{"COUNTY":"Main","SPECIES":"Pine","HEIGHT":37},
{"COUNTY":"Main","SPECIES":"Redwood","HEIGHT":78},{"COUNTY":"Main","SPECIES":"Alder","HEIGHT":45},
{"COUNTY":"First","SPECIES":"Chestnut","HEIGHT":51},{"COUNTY":"Main","SPECIES":"Hemlock","HEIGHT":17},
{"COUNTY":"Main","SPECIES":"Douglas-fir","HEIGHT":34},{"COUNTY":"First","SPECIES":"Larch","HEIGHT":12},
{"COUNTY":"Main","SPECIES":"Cedar","HEIGHT":21},{"COUNTY":"First","SPECIES":"Douglas-fir","HEIGHT":10},
{"COUNTY":"Main","SPECIES":"Redwood","HEIGHT":78}],
"hasMore":false,
"limit":100,
"offset":0,
"count":30,
"links":
[
{"rel":"self",
"href":"https://dataaccess.adb.us-ashburn-1.oraclecloudapps.com/adb/p/F5Sn..._example/data"}
]}
PAR URLの生成時にSELECT
文でバインド変数を使用する場合は、PAR URLデータにアクセスするための問合せパラメータとしてバインド変数値を渡す必要があります。バインド変数のサポートは、NUMBER
およびVARCHAR2
列タイプで使用できます。
たとえば、次のSQL文を使用してPAR URLが生成されます。
sql_statement = 'SELECT * FROM TREE_DATA WHERE COUNTY = :COUNTY'
生成されたPAR URLを、データにアクセスするための追加問合せパラメータとしてバインド変数値とともに使用します。
curl https://dataaccess.adb.us-chicago-1.oraclecloudapps.com/adb/p/K6X...example/data?COUNTY=MAIN
詳細は、GET_PREAUTHENTICATED_URLプロシージャを参照してください。