ドキュメント用REST API

メタデータ・コレクションのフォルダへの割当て

post

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

既存のメタデータ・コレクションを指定されたフォルダに関連付けます。

ノート: グローバル・コレクションをフォルダに割り当てるには、フォルダの所有者であるか、フォルダのマネージャ・ロールが必要です。 個人コレクションの場合は、フォルダのowner.である場合にのみ割り当てることができます

特定のフォルダのフィールドに値を割当て可能にするには、コレクションをその特定のフォルダに割り当てる必要があります。コレクションを1つ以上のフォルダに割当て可能で、どのフォルダにも1つ以上のコレクションを割り当てられます。

メタデータの継承:

フォルダに割り当てられたメタデータ・フィールドはすべてのフォルダと、そのフォルダ下の階層内のファイルに使用可能です。同様に、そのフィールドに割り当てる値は、ネストされたフォルダまたはファイルに明示的に定義されていないかぎり、すべてのフォルダとそのフォルダ下にネストされたファイルによって継承されます。フォルダまたはファイルに指定されたメタデータ値は、そのフォルダと、同じ継承ルールによって、そのフォルダ下にネストされた階層内のフォルダまたはファイルに継承された値を置き換えます。

リクエスト

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

application/json
application/xml

パス・パラメータ

collectionName: string

割り当てるメタデータ・コレクションの名前。
folderId: string

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

トップに戻る

レスポンス

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

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メタデータ・コレクションを指定されたフォルダに割り当てます。

POST .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata/CollectionA

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例2

次の例では、Personal.CollectionAメタデータ・コレクションを指定されたフォルダに割り当てます。

POST .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata/Personal.CollectionA

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例3

次の例は、存在しないメタデータ・コレクションを指定したフォルダに割り当てます。

POST .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata/Personal.CollectionAB

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToSetMetadata!csMetaCollectionDoesntExist,Personal.CollectionAB",
    "errorMessage": "Unable to set metadata. Metadata Collection 'Personal.CollectionAB' is not defined.",
    "errorType": "folder",
    "idList": "F94131468853B4845E0508854EE870070A1AA68C3354",
    "title": "Unable to set metadata. Metadata Collection 'Personal.CollectionAB' is not defined.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例4

次の例では、名前に含まれる無効な文字を使用して、指定したフォルダにメタデータ・コレクションを割り当てようとします。

POST .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/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"
}

先頭に戻る