获取模式 已弃用

获取 /groups/{groupId}/apps/{appId}/schemas/{schemaId}

通过 _id 值获取特定模式

路径参数

响应

  • 200 application/json

    正常

    隐藏响应属性 显示响应属性 对象
    • metadata 对象

      用于描述模式适用于哪个链接集合的元数据。

      Hide metadata attributes 显示元数据属性 对象
      • data_source 字符串

        数据源名称。

      • database 字符串

        数据库名称。

      • 集合 字符串

        collection名称。

    • 模式 对象

      集合的有效模式

      隐藏模式属性 显示模式属性 对象
      • bsonType 字符串

        字段的BSON类型

        值为 objectarraystringnumberintlongdoubledecimaldatetimestampboolnullregexobjectIdbinaryuuidfunctionjavascriptsymbolminKeymaxKey

      • 标题 字符串

        人类可读的模式标题。

      • 必需 array[string]

        对于 object 模式,为对象实例中所需字段名称的大量。

      • 属性 对象

        一个对象,其中每个字段名称都是模式中的一个属性。相应的值是该字段的模式定义。

        隐藏属性 (Attribute) 显示属性 (Attribute) 对象
        • * 对象

          集合的有效模式

    • 关系 对象

      与外部集合的关系。每个字段名称都是模式中的一个属性。相应的值是该字段的关系定义。

      隐藏关系属性 显示关系属性 对象
      • * 对象 additionalProperties

        关系定义

        隐藏 * 属性 显示 * 属性 对象
        • ref 字符串

          外部集合的引用字符串。

        • foreign_key 字符串

          该关系指向的外部集合中的字段名称。

        • is_list 布尔

          如果为 true

          • 该关系可能会点许多外部文档。
          • 本地字段必须定义为集合模式中的大量。
GET /groups/{groupId}/apps/{appId}/schemas/{schemaId}
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/schemas/{schemaId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
响应示例 (200)
{
  "metadata": {
    "data_source": "string",
    "database": "string",
    "collection": "string"
  },
  "schema": {
    "bsonType": "object",
    "title": "string",
    "required": [
      "string"
    ],
    "properties": {
      "*": {}
    }
  },
  "relationships": {
    "additionalProperty1": {
      "ref": "string",
      "foreign_key": "string",
      "is_list": true
    },
    "additionalProperty2": {
      "ref": "string",
      "foreign_key": "string",
      "is_list": true
    }
  }
}