名前パターン
すべての外部クラス名は、文字Xで始まり、その後にバージョン番号が続き、名詞(Conversation、Message、Peopleなど)が続き、クラスの機能に応じて1つ以上の修飾子が続きます。
次の表では、例として会話リソース・タイプを使用して、クラス名の表記規則および関連する関数について説明します。
| XV1Conversation | アクション |
|---|---|
| 情報 | 会話に関する情報を取得します(GET)。 |
| CreateInfo | 会話を作成し、プロパティを設定します(POST)。 |
| FilterInfo | フィルタ基準に一致する会話を取得します(GET)。 |
| MemberCreateInfo | 会話にメンバーを追加し、プロパティを設定します(POST)。 |
| MemberInfo | 会話のメンバーに関する情報を取得します(GET)。 |
| MessageCreateInfo | 会話にメッセージを追加します(POST)。 |
| PropertyCreateInfo | 会話のプロパティを設定します(POST)。 |
| PropertyInfo | 既存の会話のプロパティを取得します(GET)。 |
| PropertyUpdateInfo | 会話のプロパティを設定します(PUT)。 |
| UpdateInfo | 会話の属性を更新します(PUT)。 |
| ListInfo | すべての会話のリストを取得します(GET)。 |
| MemberListInfo | 会話のすべてのダイレクト・メンバーのリストを取得します(GET)。 |
| PropertyListInfo | 会話のすべてのプロパティのリストを取得します(GET)。 |
| StarListInfo | 星印の付いた会話とそれらのメッセージのリストを取得します(GET)。 |
XObjectID
会話用REST APIの各オブジェクトには一意のIDがあります。 十分な権限がある場合は、そのIDから、オブジェクトをロードできます。 多くのデータ転送オブジェクト(DTO)は、現在のオブジェクトに関連する他のオブジェクトのIDを指定します。 例として、ParentID, ModifiedByUserID, CreatedByUserIDおよびConversationIDがあります。 これらはすべて、システム内の他のオブジェクトへのリンクまたは参照です。
IDパラメータは、フィールドの場合はname、会話オブジェクトの場合はObjectIDまたは「外部ID」、ユーザーの場合は「オブジェクトID」または「サインイン名」を表します。