ドキュメント用REST API

機械翻訳について

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

get

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

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

リクエスト

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

application/json
application/xml

パス・パラメータ

folderId: string

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

問合せパラメータ

directAssigned(optional): string

直接割り当てられたコレクション値のみを取得する必要があるか(1)、または継承されたすべてのコレクションの値も含める必要があるか(0)を指定します。

ヘッダー・パラメータ

accessToken(optional): string

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

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

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: FolderGetCollectionResponse

タイプ: object

レスポンス本文には、コレクション値取得操作に関する情報が含まれます。

ソースを表示

errorCode(optional): string

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

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

使用可能なその他のプロパティ: Collection

割り当てられたコレクション。
type(optional): string

アイテム・タイプfolder。

{
    "description":"The response body includes information about the get collection values 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."
        },
        "metadata":{
            "$ref":"#/definitions/Collections"
        }
    }
}

ネストされたスキーマ: Collections

タイプ: object

使用可能なその他のプロパティ

ソースを表示

object 「コレクション」

使用可能なその他のプロパティ: true

Collectionのフィールドおよび値。キーは実際のフィールド名です。

{
    "type":"object",
    "description":"Assigned collections.",
    "additionalProperties":{
        "$ref":"#/definitions/Collection"
    }
}

割り当てられたコレクション。

ネストされたスキーマ: Collection

タイプ: object

使用可能なその他のプロパティ: true

Collectionのフィールドおよび値。キーは実際のフィールド名です。

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

{
    "idList":"F94131468853B4845E0508854EE870070A1AA68C3354",
    "type":"folder",
    "errorCode":"0",
    "metadata":{
        "CollectionA":{
            "FieldA1":"Value1",
            "FieldA2":"Value2"
        }
    }
}

400レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定したフォルダに関連付けられたメタデータ・コレクションが返されます。この例では、フォルダに1つのメタデータ・コレクションが関連付けられています。レスポンスには、フォルダ・コレクション(CollectionA)がリストされます。

GET .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "idList": "F94131468853B4845E0508854EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    }
  },
  "type": "folder"
}

例2

次の例では、指定したフォルダに関連付けられたメタデータ・コレクションが返されます。この例では、フォルダに2つのメタデータ・コレクションが関連付けられています。レスポンスには、フォルダ・コレクション( CollectionA)およびこのユーザーが作成し、同じフォルダに割り当てた個人コレクション( Personal.CollectionA)がリストされます。

GET .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "idList": "F94131468853B4845E0508854EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    },
    "Personal.CollectionA": {
      "A1": "personal-A1_value",
      "A2": "personal-A2_value"
    }
  },
  "type": "folder"
}

例3

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

GET .../folders/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/metadata

リクエスト・ヘッダー

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "idList": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "metadata": {
        "ApplinkCollection": {
            "appField1": "UserB_value_field1",
            "appField2": "UserB_value_field2"
        }
    },
    "type": "folder"
}

先頭に戻る