REST API

本API ではJSON 形式のOData をデータアクセスのREST プロトコルのデフォルトとして使います。OData (Atom)、SOAP、HTML、およびCSV を含む他のWeb サービスフォーマットもサポートされています。

リソース

リソースは、一般的にアイテムの集合であるエンドポイントです。リソースには次のHTTP メソッドを使ってアクセスすることができます。:

GET

HTTP GET リクエストは、指定されたリソースからデータを取得することに使われます。リソースがオブジェクトのコレクションの場合、GET リクエストはサーバーから指定したオブジェクト、もしくはすべてのオブジェクトのコレクションを取得することができます。

POST

HTTP POST リクエストはリソース内に新規オブジェクトを作成することに使われます。リクエストには作成されるエンティティの情報が含まれている必要があります。このメソッドは、リソースがオブジェクトのコレクションではない場合には使用できません。

PUT

HTTP PUT リクエストはリソースを更新することに使われます。

DELETE

HTTP DELETE リクエストはリソースを削除することに使われます。このメソッドは、リソースがオブジェクトのコレクションではない場合には使用できません。

Actions

アクションは、リソースに対するオペレーションセットを拡張することやサーバーで関連のないアクションを実行することに使われます。

一般的なサーバーレスポンス

200 OK リクエストはエラーなしでサーバーにより処理されました。
201 Created リクエストは成功し、指定されたリソースがサーバーによって作成されました。
204 No Content リクエストされたリソースがnull 値もしくは、サービスがreturn=minimal preference が適用される場合、リクエストはこのステータスを返します。
400 Bad Request リクエストは受付できないか、必要なパラメータを満たしていません。
401 Unauthorized このユーザーは認証されていないか、このリソースへのアクセスが承認されていません。
403 Forbidden このリソースへのアクセスが拒否されました。
404 Not Found このレスポンスはリソースが存在しないことを示します。
405 Method Not Allowed 指定されたHTTP メソッドはこのリソースでは許可されていません。
501 Not Implemented サーバーは、リクエストを充足する機能をサポートしていません。

認証

認証トークンは、ユーザーがAPI に認証をするためのユニークな認識子です。認証トークンを使用するには、管理者としてログインして、ユーザー管理 をクリックしてください。このセクションでは、ユーザーの権限および認証トークンの管理について説明します。API のアクセスを特定のIP アドレスに限定することもできます。

API を呼び出すには認証トークンをさまざまな方法で指定できます。

Basic 認証

Basic 認証では、ユーザー認証トークンはパスワードとして使われます。

HTTP ヘッダー

HTTP ヘッダー "x-cdata-authtoken" を希望する認証トークンとともにHTTP リクエストとして追加します。

クエリ文字列パラメータ

HTTP フォームポストデータ、もしくはクエリパラメータとして認証トークンを"@authtoken" に指定します。

追加フォーマット

すべてのAPI リソースおよびアクションがサポートするデフォルトのJSON OData フォーマットに加えて、すべてのAPI において次のWeb サービスフォーマットがサポートされています。インプットカラムは、特定のフォーマットをリクエストするときに必要な追加インプットを説明します。

フォーマット インプット 説明
OData (Atom) $format=Atom OData の代替XML アイテムエンコード。
JSONP $callback=MyCallback ブラウザスクリプトでの利用のためにアウトプットはJSONP フォーマットに変換されます。
RSS @RSS Normal XML RSS 2.0 エンコードで、多くのブラウザで自動フォーマットされます。
SOAP @WSDL RSS と類似したXML アイテムのエンコーディング形式。
HTML @HTML アウトプットはベーシックHTML テーブルとしてフォーマットされます。
CSV @CSV スプレッドシートへのローディングではアウトプットはカンマ区切りの値に変換されます。
TSV @TSV スプレッドシートへのローディングではアウトプットはタブ区切りの値に変換されます。
CData APIServer™ 2018 - 18.0.7065.0