ドキュメント用REST API

機械翻訳について

フォルダ・メタデータ・コレクションの値の削除

delete

/documents/api/1.2/folders/{folderId}/metadata

メタデータ・コレクションの指定されたフィールドの値をリセット(削除)します。

ノート: フォルダからメタデータ値を削除するには、フォルダの所有者であるか、フォルダのマネージャ・ロールが必要です。

リクエスト

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

application/json
application/xml

パス・パラメータ

folderId: string

フォルダのグローバル一意識別子(GUID)。参照されるフォルダがユーザーのホーム・フォルダの場合、folderIdの値はselfです。

問合せパラメータ

collection: string

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

削除対象の値を持つ、カンマで区切られた1つ以上のフィールド名。

ヘッダー・パラメータ

accessToken(optional): string

現在のユーザーにこのフォルダへのアクセスを許可するApplinkアクセス・トークン。このパラメータは、appLinkIDが使用されている場合は必須です。これはaccessTokenまたはAccessTokenとして使用できます。
appLinkID(optional): string

現在のユーザーにこのフォルダへのアクセスを許可するApplink ID。パラメータappLinkIDが使用されるときはいつでも、パラメータaccessTokenも提供されなければなりません。働くには、このapplinkは、少なくともコントリビュータ・ロールが付与されていなければなりません。 appLinkIDまたはAppLinkIDとして使用できます。

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: FolderCollectionResponse

タイプ: object

レスポンス本文には、フォルダへのコレクション割当て操作に関する情報が含まれます。

ソースを表示

errorCode(optional): string

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

元フォルダのグローバル一意識別子(GUID)
type(optional): string

アイテム・タイプfolder。

{
    "description":"The response body includes information about the assign collection to a folder operation.",
    "properties":{
        "idList":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the original folder."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>folder</code>."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

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

{
    "idList":"F94131468853B4845E0508854EE870070A1AA68C3354",
    "type":"folder",
    "errorCode":"0"
}

400レスポンス

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

404レスポンス

フォルダIDが見つかりません。

トップに戻る

例

次の例では、指定されたフォルダに関連付けられたCollectionAメタデータ・コレクションのA1およびA2フィールドの値を削除します。

DELETE .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata?collection=CollectionA&fields=A1,A2

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "idList": "F94131468853B4845E0508854EE870070A1AA68C3354",
  "type": "folder"
}

例2

次の例では、指定されたフォルダに関連付けられたPersonal.CollectionAメタデータ・コレクションのA1およびA2フィールドの値を削除します。

DELETE .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata?collection=Personal.CollectionA&fields=A1,A2

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "idList": "F94131468853B4845E0508854EE870070A1AA68C3354",
  "type": "folder"
}

例3

次の例では、指定されたフォルダに関連付けられたApplinkCollectionメタデータ・コレクションのappField1およびappField2フィールドの値を削除します。現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

DELETE .../folders/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/metadata?collection=ApplinkCollection&fields=appField1,appField2

リクエスト・ヘッダー

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "idList": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "type": "folder"
}

先頭に戻る