ドキュメント用REST API

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

post

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

指定されたフォルダ・メタデータ・コレクションのフィールドに値を割り当てます。特定のフォルダのフィールドに値を割当て可能にするには、コレクションをその特定のフォルダに割り当てる必要があります。

ノート: フォルダでメタデータ値を設定するには、そのフォルダのコントリビュータまたはマネージャのロールが必要です。

メタデータの継承:

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

リクエスト

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

application/json
application/xml

パス・パラメータ

folderId: string

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

ヘッダー・パラメータ

accessToken(optional): string

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

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

リクエスト本文では、メタデータ・コレクションへの値割当てリクエストの詳細を定義します。必須の属性はありません。

ルート・スキーマ: FolderAssignValuesBody

タイプ: object

1つ以上のフィールド名。たとえば、コレクション名とフィールド名を個別に参照できます:

{

"collection": "CollectionA,"

"FieldA1": "Value1,"

"FieldA2": "Value2"

}

もう1つの方法として、コレクションとフィールド名を各フィールド参照で指定できます。

{

"CollectionA.FieldA1": "Value1,"

"CollectionA.FieldA2": "Value2"

}

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

トップに戻る

レスポンス

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

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

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "collection": "CollectionA",
    "A1": "A1_value",
    "A2": "A2_value"
}

次のリクエスト本文は各フィールド参照によってコレクションを明示的に参照します。

{
    "CollectionA.A1": "A1_value",
    "CollectionA.A2": "A2_value"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例2

次の例では、指定されたフォルダに関連付けられたPersonal.CollectionAメタデータ・コレクションのフィールドに、指定された文字列値を割り当てます。

POST .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "collection": "Personal.CollectionA",
    "A1": "personal-A1_value",
    "A2": "personal-A2_value"
}

次のリクエスト本文は各フィールド参照によってコレクションを明示的に参照します。

{
    "Personal.CollectionA.A1": "personal-A1_value",
    "Personal.CollectionA.A2": "personal-A2_value"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例3

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

POST .../folders/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/metadata

リクエスト・ヘッダー

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

リクエスト本文

{
    "collection": "ApplinkCollection",
    "appField1": "UserB_value_field1",
    "appField1": "UserB_value_field2"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

先頭に戻る