> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI

> Connect AI は OpenAPI 仕様バージョン 2.0 および 3.0 をサポートしており、OpenAPI と連携するノーコード/ローコードアプリケーションに接続できます。Connect AI では、ワークスペースから OpenAPI ドキュメントをダウンロードできます。

## ワークスペースの OpenAPI ファイルの生成

選択したワークスペースの OpenAPI 仕様ファイルを生成できます。このファイルは、クライアントアプリケーションで OpenAPI を通じて Connect AI と連携するために使用できます。

OpenAPI 仕様ファイルを生成するには

<Steps>
  <Step>
    ダッシュボードで **Workspaces** を選択します。
  </Step>

  <Step>
    OpenAPI 仕様ファイルを生成するワークスペースを選択します。このファイルは、クライアントアプリケーションで OpenAPI を通じて Connect AI と連携するために使用できます。
  </Step>

  <Step>
    上部メニューで **View Endpoints** をクリックします。
    **Endpoints** ダイアログが表示されます。
  </Step>

  <Step>
    **OpenAPI** タブを選択します。

    <Frame>
      <img src="https://mintcdn.com/cdata/bW2_IPnFDk_aW2FG/ja/images/endpoints_openapi.png?fit=max&auto=format&n=bW2_IPnFDk_aW2FG&q=85&s=28e628ae776409f47d3a68250e8589b9" alt="" width="749" height="528" data-path="ja/images/endpoints_openapi.png" />
    </Frame>
  </Step>

  <Step>
    OpenAPI のバージョン 3.0 または 2.0 を選択します。
  </Step>

  <Step>
    クライアントアプリケーションが配列型をサポートしていない場合（Microsoft Power Apps など）は、**Convert array types to strings** をオンにします。
  </Step>

  <Step>
    **Download** をクリックして、ワークスペースの OpenAPI 仕様ファイルをダウンロードします。このファイルはクライアントアプリケーションにインポートされます。

    <Note>
      一部のインテグレーションツールでは、ダウンロードした仕様ファイルの代わりに OpenAPI URL を受け付けます。その場合は、このダイアログの OpenAPI URL をコピーしてください。詳細はインテグレーションツールのドキュメントを参照してください。
    </Note>
  </Step>

  <Step>
    **Close** をクリックします。
  </Step>
</Steps>

## API 操作

データセットに公開されている各エンティティ *EntityName* に対して、OpenAPI は以下の操作を提供します。各操作の入力については以下のセクションで説明します。

* List*EntityName*
* Get*EntityName*
* Create*EntityName*
* Delete*EntityName*
* Update*EntityName*
* GetCount*EntityName*

### List*EntityName*

List 操作は、データセット内のすべてのエンティティに対して GET リクエストを実行します。List で使用できる入力は次のとおりです。

* `$top=N` は結果の最初の *N* 件のレコードのみを含めます。例えば、`$top=10` はエンティティの上位 10 件のレコードのみを返します。
* `$skip=N` は結果から最初の *N* 件のレコードをスキップします。例えば、`$skip=10` はエンティティの最初の 10 件のレコードをスキップし、11 件目のレコードから始めます。
* `$filter` はデータセット内のエンティティに `gt`（より大きい）や `eq`（等しい）などの OData 演算子を適用します。演算子の完全なリストについては [\$filter](/ja/API/OData-Query-Options#odata-filter) を参照してください。
* `$orderby` はエンティティのレコードをプロパティでソートします。プロパティはカンマで区切ります。`asc`（昇順）または `desc`（降順）でソートできます。デフォルト値は `asc` です。例えば、データセットを `Model`（昇順）、次に `Color`（降順）で並べるには `$orderby=Model asc, Color desc` のように指定します。
* `$select` はプロパティのサブセットを取得します。例えば、データセット内のすべてのレコードのプロパティ `Id` と `Model` を返すには `$select=Id, Model` のように指定します。

### Get*EntityName*

Get 操作は、データセット内のエンティティに対して GET リクエストを実行します。Get で使用できる入力は次のとおりです。

* `Id`（または他のプライマリキー）は、データセット内のリクエストされたエンティティの一意の識別子です。

### Create*EntityName*

Create 操作は、データセットにエンティティを追加するための POST リクエストを実行します。Create の入力は次のとおりです。

* `body` は POST リクエストのボディで、エンティティのプロパティを含みます。

### Delete*EntityName*

Delete 操作は、エンティティを削除するための DELETE リクエストを実行します。Delete の入力は次のとおりです。

* `Id`（または他のプライマリキー）は、削除するリクエストされたエンティティの一意の識別子です。

### Update*EntityName*

Update 操作は、エンティティを更新するための PATCH リクエストを実行します。Update の入力は次のとおりです。

* `Id`（または他のプライマリキー）は、更新するリクエストされたエンティティの一意の識別子です。
* `body` はリクエストのボディで、更新するエンティティのプロパティを含みます。

### GetCount*EntityName*

GetCount 操作は、リソースの数を取得するための GET リクエストを実行します。GetCount の入力は次のとおりです。

* `$filter` はデータセット内のエンティティに `gt`（より大きい）や `eq`（等しい）などの OData 演算子を適用します。演算子の完全なリストについては [\$filter](/ja/API/OData-Query-Options#odata-filter) を参照してください。