機械翻訳について
  1. ドキュメント用REST API
  2. タスク
  3. フォルダ

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

get

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

特定のフォルダに割り当てられた、指定されたメタデータ・コレクション内のすべてのフィールドのフィールド定義を取得します。

リクエスト

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

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

問合せパラメータ

  • 直接割り当てられたコレクションを取得するか(1)、またはすべての継承されたコレクションを同様に組み込むか(0)を指定します。

ヘッダー・パラメータ

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

  • 現在のユーザーにこのフォルダへのアクセスを許可するApplink ID。 パラメータappLinkIDが使用されるときはいつでも、パラメータaccessTokenも提供されなければなりません。 appLinkIDまたはAppLinkIDとして使用できます。

トップに戻る

レスポンス

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

200レスポンス

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

本文 ()
ルート・スキーマ: FolderGetAssignedCollectionResponse
タイプ: object
レスポンス本文には、割当て済コレクション取得操作に関する情報が含まれます。
ソースを表示
ネストされたスキーマ: metadataFields
タイプ: array
ソースを表示
ネストされたスキーマ: CollectionDefinition
タイプ: object
メタデータ・コレクション定義。
ソースを表示
ネストされたスキーマ: items
タイプ: array
フィールド定義のリスト。
ソースを表示
ネストされたスキーマ: CollectionFieldDefinition
タイプ: object
メタデータ・フィールド定義。
ソースを表示
レスポンスの例(application/json)
{
    "idList":"F94131468853B4845E0508854EE870070A1AA68C3354",
    "type":"folder",
    "errorCode":"0",
    "metadataFields":{
        "CollectionA":{
            "isEnabled":1,
            "isInherited":0,
            "type":"collection",
            "items":[
                {
                    "type":"field",
                    "fieldName":"A1",
                    "fieldType":"string",
                    "isEnabled":1
                },
                {
                    "type":"field",
                    "fieldName":"A2",
                    "fieldType":"string",
                    "isEnabled":0
                }
            ]
        }
    }
}

400レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定したフォルダに関連付けられたメタデータ・コレクション・フィールドが返されます。 この例では、フォルダに1つのメタデータ・コレクションが関連付けられています。 メタデータ・コレクションについて、レスポンスですべてのフィールドの定義が返されます。 また、ステータス・フィールドの値isEnabledは、コレクションまたはフィールドが有効化されているか(1)、または無効化されているか(0)を示します。 フィールドisInheritedは、CollectionAがこのフォルダに直接割り当てられているため、0が継承されていないことを示しています。 

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001/metadataFields

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "idList": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "metadataFields": {
        "CollectionA": {
            "isEnabled": "1",
            "isInherited": "0",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "A1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "A2",
                    "fieldType": "string",
                    "isEnabled": "0"
                }
            ]
        }
    },
    "type": "folder"
}

例2

次の例では、指定したフォルダに関連付けられたメタデータ・コレクション・フィールドが返されます。 この例では、フォルダに2つのメタデータ・コレクションが関連付けられています。これには、このユーザーが作成し、このフォルダに割り当てた個人コレクション(Personal.CollectionA)が含まれます。 メタデータ・コレクションについて、レスポンスですべてのフィールドの定義が返されます。 また、ステータス・フィールドの値isEnabledは、コレクションまたはフィールドが(1)または無効な(0)のどちらで有効になっているかを示します。 フィールドisInheritedは、CollectionAおよびPersonal.CollectionAは、このフォルダに直接割り当てられているため、継承されないことを示しています(0)。 

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001/metadataFields

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "idList": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "metadataFields": {
        "CollectionA": {
            "isEnabled": "1",
            "isInherited": "0",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "A1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "A2",
                    "fieldType": "string",
                    "isEnabled": "0"
                }
            ]
        },
        "Personal.CollectionA": {
            "isEnabled": "1",
            "isInherited": "0",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "A1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "A2",
                    "fieldType": "string",
                    "isEnabled": "0"
                }
            ]
        }
    },
    "type": "folder"
}

例3

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

GET .../folders/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/metadataFields

リクエスト・ヘッダー

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "idList": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "metadataFields": {
        "ApplinkCollection": {
            "isEnabled": "1",
            "isInherited": "0",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "appField1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "appField2",
                    "fieldType": "string",
                    "isEnabled": "1"
                }
            ]
        }
    },
    "type": "folder"
}
先頭に戻る