QamaqQamaq
APIドキュメントに戻る

カスタムエンティティ

カスタムエンティティスキーマとレコードを操作します。エンティティを使用すると、カスタムフィールドとリレーションシップでビジネスデータをモデリングできます。

エンドポイント (10)

GET

エンティティレコード一覧

/entities/{entity_key}/records

エンティティのページネーションされたレコードのリストを返します。

POST

エンティティレコードを作成

/entities/{entity_key}/records

エンティティの新しいレコードを作成します。

GET

エンティティレコードを取得

/entities/{entity_key}/records/{record_id}

IDで指定された特定のエンティティレコードを返します。

PATCH

エンティティレコードを更新

/entities/{entity_key}/records/{record_id}

既存のエンティティレコードを更新します。

DELETE

エンティティレコードを削除

/entities/{entity_key}/records/{record_id}

エンティティレコードを削除します。

GET

エンティティバージョン一覧

/entities/{entity_key}/versions

エンティティスキーマのすべてのバージョンを返します。

GET

エンティティバージョンを取得

/entities/{entity_key}/versions/{version_id}

フィールドとレイアウトを含む特定のエンティティバージョンの詳細を返します。

GET

アクティブなエンティティバージョンを取得

/entities/{entity_key}/versions/active

エンティティの現在アクティブなバージョンをフルスキーマ付きで返します。

GET

エンティティスキーマ一覧

/entities/schema

組織内で利用可能なすべてのエンティティスキーマのリストを返します。

GET

エンティティスキーマを取得

/entities/schema/{entity_key}

entity_keyで指定された特定のエンティティスキーマの詳細を返します。