ドキュメント用REST API

機械翻訳について

メタデータ・コレクション削除

delete

/documents/api/1.2/metadata/{collectionName}

メタデータ・コレクションと、ファイルまたはフォルダに割り当てられたそのすべての値を削除します。

リクエスト

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

application/json
application/xml

パス・パラメータ

collectionName: string

コレクション名。ユーザー個人コレクションの場合は、Personal.MyCollectionなどのPersonal.で始まる必要があります。

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: CollectionDeleteResponse

タイプ: object

レスポンス本文には、メタデータ・コレクションの削除に関する情報が含まれます。

ソースを表示

errorCode(optional): number

エラー・コードがゼロ(0)の場合は、エラーなしです

{
    "description":"The response body includes information about deleting a metadata collection.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

400レスポンス

リクエスト・パラメータが正しい形式ではありません。

その名前のコレクションは存在しません。

トップに戻る

例

次の例では、CollectionBメタデータ・コレクションを削除します。

DELETE .../metadata/CollectionB

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0"
}

例2

次の例では、Personal.CollectionAメタデータ・コレクションを削除します。

DELETE .../metadata/Personal.CollectionA

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0"
}

例3

次の例では、存在しないメタデータ・コレクションを削除しようとします。

DELETE .../metadata/Personal.CollectionAB

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToDeleteMetaColDef!csMetaCollectionDoesntExist,Personal.CollectionAB",
    "errorMessage": "Unable to delete metadata collection definition. Metadata Collection 'Personal.CollectionAB' is not defined.",
    "title": "Unable to delete metadata collection definition. Metadata Collection 'Personal.CollectionAB' is not defined.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例4

次の例では、名前に含まれる無効な文字を使用して、メタデータ・コレクションを削除しようとします。

DELETE .../metadata/Personal.CollectionA,B

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-96",
    "errorKey": "!csCollectionNameInvalidCharacters,Personal.CollectionA\\,B",
    "errorMessage": "Invalid characters in the collection name 'Personal.CollectionA,B'.",
    "title": "Invalid characters in the collection name 'Personal.CollectionA,B'.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る