Jump to

• Request
• Response
• Examples

Get File Metadata Collection

get

/documents/api/1.2/files/{fileId}/metadata

Get values assigned to fields in a specified metadata collection for a particular file.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• fileId: string

  Globally unique identifier (GUID) for the file.

Query Parameters

• directAssigned(optional): string

  Specify if just directly assigned collection values should be retrieved (1) or if values from all inherited collections should be included as well (0).

Header Parameters

• accessToken(optional): string

  Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if appLinkID is used. It can be used as accessToken or AccessToken.

• appLinkID(optional): string

  Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. It can be used as appLinkID or AppLinkID.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : FileGetCollectionResponse

Type: object

The response body includes information about the assign collection operation.

Show Source

• errorCode(optional): number
  An error code of zero (0) indicates no errors.
• idList(optional): string
  Globally unique identifier (GUID) of the original file.
• metadata(optional): object Collections
  Additional Properties Allowed: Collection

  Assigned collections.
• type(optional): string
  Item type file.

{
    "description":"The response body includes information about the assign collection operation.",
    "properties":{
        "idList":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the original file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "metadata":{
            "$ref":"#/definitions/Collections"
        }
    }
}

Nested Schema : Collections

Type: object

Additional Properties Allowed

Show Source

• object Collection
  Additional Properties Allowed: true

  Collection fields and values, where keys are the actual field name.

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

Assigned collections.

Nested Schema : Collection

Type: object

Additional Properties Allowed: true

Collection fields and values, where keys are the actual field name.

Example Response (application/json)

{
    "idList":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "errorCode":"0",
    "metadata":{
        "CollectionA":{
            "FieldA1":"Value1",
            "FieldA2":"Value2"
        },
        "CollectionB":{
            "FieldB1":"Value1",
            "FieldB2":"Value2"
        }
    }
}

400 Response

Request parameters are not formatted correctly.

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID is not found.

Back to Top

Examples

The following example returns the metadata collection associated with the specified file. In this example, both the file and the parent folder have metadata collections associated with them. The response lists the folder collection (CollectionA) followed by the file collection (CollectionB).

GET .../files/D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354/metadata

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "idList": "D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    },
    "CollectionB": {
      "B1": "B1_value",
      "B2": "B2_value"
    }
  },
  "type": "file"
}

Example 2

The following example returns the metadata collection associated with the specified file. In this example, both the file and the parent folder have metadata collections associated with them. The response lists the folder collection (CollectionA) followed by the file collection (CollectionB). It also lists a personal collection (Personal.CollectionA) created by the user and assigned to the parent folder.

GET .../files/D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354/metadata

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "idList": "D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    },
    "CollectionB": {
      "B1": "B1_value",
      "B2": "B2_value"
    },
    "Personal.CollectionA": {
      "A1": "personal-A1_value",
      "A2": "personal-A2_value"
    }
  },
  "type": "file"
}

Example 3

The following example returns the metadata collection associated with the specified file. The example uses an applink ID because this file is under a folder structure not owned by or shared with the current user. The applink ID and access token are submitted in the request header.

GET .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/metadata

Request Header

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

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "metadata": {
        "ApplinkCollection": {
            "appField1": "UserB_valueFile_field1",
            "appField2": "UserB_valueFile_field2"
        }
    },
    "type": "file"
}

Back to Top