REST概要

Backlot APIのすべてのリソースにはそれぞれのURLがあります。リソースの URLにリクエストを送信およびリクエスト内で標準HTTPメソッドを使用することで、リソースを表示、 修正および削除することができます。

リクエスト発行にはあらゆるHTTPライブラリまたはツールを使用することができます。Backlot APIは次のHTTPメソッドをサポートしています。それぞれ以下で説明されている 様式化された関数を持ちます。

  • GET: リソースの表示
  • POST: 新規リソースの作成
  • DELETE: リソースの削除
  • PUT: 既存リソースを置き換え、リソースを作成
  • PATCH: 既存リソースの更新または修正
注:

すべてのリクエストはHTTPSを使用して送信してください。

すべてのルートが上記リクエストをサポートしているわけではありません。

通常、POSTリクエストは、リソースに対してPATCHリクエストと同じパラメータを取ります。

新規リソース作成時は、POSTリクエストを使用してください。リソースの要件により、リクエストのボディにオブジェクトのJSON表現を含めることで、リソースを設定します。次の例は名前だけを指定してラベルを作成します。

[POST] /v2/labels
{
  "name": "Leisure"
}
  

名前しか設定していませんが、Backlotは自動的にデフォルト値を使用して残りの設定を構成します。

リクエストに成功すると、Backlot APIは次のようなレスポンスを返します。

{
  "name": "Leisure",
  "id": "9d765ce4b3884f8",
  "full_name": "/Leisure",
  "parent_id": null
}	
  

GETリクエストを発行することで、いつでもこの情報を取得することができます。たとえば、次のリクエストは9d765ce4b3884f8 IDを持つラベルの設定を返します。

  [GET] /v2/labels/9d765ce4b3884f8
  

この情報を用いて、PATCHリクエストでリソースを修正することができます。たとえば、次のリクエストはラベルの名前をRecreationに変更します。

[PATCH] /v2/labels/9d765ce4b3884f8  
{
  "name": "Recreation"
}
  

リクエストに成功すると、Backlot APIは次のようなレスポンスを返します。

{
  "name": "Recreation",
  "id": "9d765ce4b3884f8",
  "full_name": "/Recreation",
  "parent_id": null
}
  

この記事はお役にたちましたか?