Documentation

GetFiles

Retrieves file metadata from an entity's profile.

Request Details

Returns URLs that may be used to download the files for a profile for a limited length of time. Only returns files that have been successfully uploaded, files that are still pending will either return the old value, if it exists, or nothing.

GetFilesRequest
Request Properties
Entity (required) EntityKey

The entity to perform this action on.

POST https://{{TitleID}}.playfabapi.com/File/GetFiles
    Content-Type: application/json
{
  "Entity": {
    "Id": "ID",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
        

Response Details

GetFilesResponse
Result Properties
Entity EntityKey

The entity id and type.

Metadata Dict<String, GetFileMetadata>

Collection of metadata for the entity's files

ProfileVersion (required) int32

The current version of the profile, can be used for concurrency control during updates.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "ProfileVersion": 5,
    "Metadata": {
      "game_settings": {
        "FileName": "game_settings",
        "DownloadUrl": "https://...",
        "Size": 5683,
        "Checksum": "97129sdlkj9129",
        "LastModified": "2017-12-05T17:36:05Z"
      }
    },
    "Entity": {
      "Id": "ID",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    }
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code