機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

APIカタログの取得

get

/documents/api/{version}/metadata-catalog

指定したバージョンのAPIで使用可能なリソースを取得します。

ノート:

Content Management REST APIのバージョン1.1で、カタログ・リソースはMetadata-Catalogという名前に変更されました。 カタログは、メタデータ-カタログの別名として引き続きサポートされます。

リクエスト

サポートされるメディア・タイプ

• application/json
• application/xml

パス・パラメータ

• version: string
  バージョン値

トップに戻る

レスポンス

サポートされるメディア・タイプ

• application/json
• application/xml

200レスポンス

リクエストが処理されました。

本文 ()

ルート・スキーマ: CatalogResponse

タイプ: object

レスポンス本文には、APIカタログ取得操作に関する情報が含まれます。

ソースを表示

• links(optional): array links
  カタログのリスト。

{
    "description":"The response body includes information about the get API catalog operation.",
    "properties":{
        "links":{
            "type":"array",
            "description":"List of catalogs.",
            "items":{
                "$ref":"#/definitions/CatalogDefinition"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

カタログのリスト。

ソースを表示

• Array of: object CatalogDefinition
  カタログ

{
    "type":"array",
    "description":"List of catalogs.",
    "items":{
        "$ref":"#/definitions/CatalogDefinition"
    }
}

ネストされたスキーマ: CatalogDefinition

タイプ: object

カタログ

ソースを表示

• links(optional): array links
  カタログ・リンクのリスト。
• name(optional): string
  カタログの名前。

{
    "description":"Catalog information.",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the catalog."
        },
        "links":{
            "type":"array",
            "description":"List of catalog links.",
            "items":{
                "$ref":"#/definitions/APILinks"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

カタログ・リンクのリスト。

ソースを表示

• Array of: object APILinks
  APIリンク情報。

{
    "type":"array",
    "description":"List of catalog links.",
    "items":{
        "$ref":"#/definitions/APILinks"
    }
}

ネストされたスキーマ: APILinks

タイプ: object

APIリンク情報。

ソースを表示

• href(optional): string
  リソースを一意に定義する完全なURL。
• ref(optional): string
  関係。

{
    "description":"API links information.",
    "properties":{
        "ref":{
            "type":"string",
            "description":"Relationship."
        },
        "href":{
            "type":"string",
            "description":"Complete URL that uniquely defines the resource."
        }
    }
}

レスポンスの例(application/json)

{
    "items":[
        {
            "name":"folders",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/folders"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/folders"
                }
            ]
        },
        {
            "name":"files",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/files"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/files"
                }
            ]
        },
        {
            "name":"users",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/users"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/users"
                }
            ]
        },
        {
            "name":"applinks",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/applinks"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/applinks"
                }
            ]
        },
        {
            "name":"shares",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/shares"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/shares"
                }
            ]
        },
        {
            "name":"publiclinks",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/publiclinks"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/publiclinks"
                }
            ]
        },
        {
            "name":"metadata",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/metadata"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/metadata"
                }
            ]
        },
        {
            "name":"configuration",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/configuration"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/configuration"
                }
            ]
        },
        {
            "name":"sites",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/sites"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/sites"
                }
            ]
        },
        {
            "name":"templates",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2/metadata-catalog/templates"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.2/templates"
                }
            ]
        }
    ]
}

トップに戻る

例

次の例では、指定したバージョンの情報が返されます。

GET .../api/1.2/metadata-catalog

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "items":[
    {
      "name": "folders",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/folders"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/folders"
      	}
      ]
    },
    {
      "name": "files",
      "links": [
        {
          "rel": "canonical",
          "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/files"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/files"
        }
      ]
    },
    {
      "name": "shares",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/shares"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/shares"
      	}
      ]
    },
    {
      "name": "users",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/users"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/users"
      	}
      ]
    },
    {
      "name": "applinks",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/applinks"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/applinks"
      	}
      ]
    },
    {
      "name": "publiclinks",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/publiclinks"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/publiclinks"
      	}
      ]
    },
    {
      "name": "metadata",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/metadata"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata"
      	}
      ]
    },
    {
      "name": "configuration",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/configuration"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/configuration"
      	}
      ]
    },
    {
      "name": "collections",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/collections"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/collections"
      	}
      ]
    },
    {
      "name": "sites",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/sites"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/sites"
      	}
      ]
    },
    {
      "name": "templates",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/templates"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/templates"
      	}
      ]
    }
  ]
}

先頭に戻る