path パラメータ

• グループ ID string 必須

  Atlas Project/Group ID。

• appId string 必須

  アプリケーションの ObjectID。App Services API プロジェクトとアプリケーション ID のセクションでは、この値を見つける方法が示されています。

• schemaId string 必須

  スキーマのユニークな _id 値。

応答

• 200 application/ JSON

  OK

  応答属性の非表示 応答属性の表示 オブジェクト

  • metadata オブジェクト

    スキーマが適用される、リンクされたコレクションを記述するメタデータ。

    Hide metadata attributes メタデータ属性の表示 オブジェクト

    • data_source string

      データソース名。

    • database string

      データベース名。

    • コレクション string

      コレクション名。

  • スキーマ オブジェクト

    コレクションに対する有効なスキーマ。

    スキーマ属性の非表示 スキーマ属性の表示 オブジェクト

    • bsonType string

      フィールドのBSON type。

      値は object、array、string、number、int、long、double、decimal、date、timestamp、bool、null、 regex、objectId、binary、uuid、function、javascript、symbol、minKey、または maxKey 。

    • title string

      スキーマの人間が判読可能なタイトル。

    • 必須 array[string]

      object スキーマの場合、オブジェクトのインスタンスに必要なフィールド名の配列。

    • properties オブジェクト

      各フィールド名がスキーマ内のプロパティであるオブジェクト。対応する値は、そのフィールドのスキーマ定義です。

      プロパティ属性を非表示 プロパティ属性を表示 オブジェクト

      • * オブジェクト

        コレクションに対する有効なスキーマ。

  • relationships オブジェクト

    外部コレクションとの関係。各フィールド名はスキーマ内のプロパティです。対応する値は、そのフィールドの関係の定義です。

    関係属性を非表示 関係属性の表示 オブジェクト

    • * オブジェクト additionalProperties

      関係の定義。

      * 属性を非表示 * 属性を表示 オブジェクト

      • 参照 string

        外部コレクションの参照列。

      • foreign_key string

        関係がポイントする外部コレクション内のフィールドの名前。

      • is_list ブール値

        true場合:

        • その関係は多くの外部ドキュメントを点場合があります。
        • ローカルフィールドは、コレクションスキーマ内で配列として定義する必要があります。