プラットフォーム › 公開されたAPI
暴露
一度決定すれば、画面のうちどの列、どの行を外部に持ち出すか、また、何かを書き戻せるかどうかといったことまで、すべて外部からアクセスできない。ここで公開されるまでは外部からアクセスすることはできず、「すべてを公開する」という選択肢もない。
どこで見つけられるか
コンソールのアドレス: /platform/api-exposures
リスト · 11 列 · 16 そのフォーム上のフィールド · 4 それらのうち必要なのは
リストの内容
これらはリストの列であり、描画された順序で並んでいます。これらの列はいずれも、並べ替え、フィルタリング、非表示、またはエクスポートが可能です。
| カラム | 親切 | フィールド名 |
|---|---|---|
| 公開 | コード | code |
| 名前 | 文章 | name |
| モジュール | 状態 | module_key |
| 画面 | コード | resource_key |
| アクセス | 状態 | access_summary |
| コラム | 文章 | column_summary |
| 最大行数 | 番号 | max_rows |
| キー | 番号 | granted_to |
| 通話（30日） | 番号 | calls_30d |
| 最後に電話した | 日時 | last_called_at |
| 状態 | 状態 | status |
フォーム
レコード作成時にここで求められる項目について説明します。必須項目にはマークが付いています。構成リストから選択した項目は、管理者がリリースなしで拡張できるものです。
| 分野 | タイプ | 選択肢 | 注記 |
|---|---|---|---|
| 公開 必須 | 文章 | 外部ではこれをこう呼んでいます。これはURLとMCPツール名です。画面名とは意図的に分けられているため、ここで画面名を変更しても、誰かのシステム統合が壊れることはありません。 | |
| 名前 必須 | 文章 | ||
| それは何なのか | 長文 | OpenAPIドキュメントの開発者とMCPツールリストのモデルによって読み取られる。特筆すべき点として、ここで「注文」が発注書を意味すると明記されているのはここだけである。 | |
| モジュール 必須 | 文章 | API Studioのピッカーから選択してください。入力する必要はありません。リストは製品自体から読み込まれます。 | |
| 画面 必須 | 文章 | ||
| 読むことができる | はい、もしくは、いいえ | ||
| 作成可能 | はい、もしくは、いいえ | API を介して作成されたデータは、画面上で入力されたデータと同じ検証、番号付け、および投稿ルールに従います。 | |
| 変更される可能性があります | はい、もしくは、いいえ | ||
| 削除される可能性があります | はい、もしくは、いいえ | ||
| コラム | 選択 | 掲載, 全て, すべて | listing — 下記に指定されたもののみを送信します。 all — すべての列。 all_but — 下記に指定されたものを除くすべて。 |
| 列名 | 文章 | カンマ区切りです。ここで名前のスペルが間違っていても発音されないため、画面に実際に何が表示されるかを確認できるAPI Studioのピッカーを使用してください。 | |
| 移動する可能性のある列 | 文章 | すべてのリスト画面で共通して使用されるフィルターは、{"col":"status","op":"eq","value":"posted"} です。これはサーバー側で呼び出しごとに適用され、呼び出し元が送信するフィルターはこれとAND演算で結合されます。呼び出し元が送信できるフィルターの範囲は、このフィルターの幅を広げるものではありません。 | |
| 1回の呼び出しあたりの最大行数 | 番号 | ||
| MCPツールとして提供する | はい、もしくは、いいえ | ||
| モデルに何を伝えるべきか | 長文 | モデルに開発者が指示しないような情報を伝える必要がある場合にのみ使用されます。空欄の場合は、上記の記述が使用されます。 | |
| 状態 | 選択 | 下書き, アクティブ, 一時停止中, 退職 | 実際に公開されているものだけがアクセス可能です。下書きは、誰かがまだ作成中の決定事項です。 |
ここに適用されるルール
この画面上のすべての要素は、独自のルールではなくプラットフォームのルールに従います。使用前に知っておくべきルールは以下のとおりです。
- リストを絞り込む — 検索、条件、並べ替え、合計、エクスポート、保存済みビュー。
- 変更される可能性のあるもの — 記録の編集が認められない5つの根拠。
- 企業および事業部門 — このリストの上にあるスイッチャーがそれに対して何をしているのか。
- 記録を作成する — 必須項目、選択肢の出典、および数値の割り当て方法。
- スプレッドシートのインポート — この画面は1つの入力を受け付け、入力時と同じルールに従って処理されます。