File - Get Files

Retrieves file metadata from an entity's profile.

POST https://titleId.playfabapi.com/File/GetFiles

Request Header

Name Required Type Description
X-EntityToken True

string

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name Required Type Description
Entity True

EntityKey

The entity to perform this action on.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name Type Description
200 OK

GetFilesResponse

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

GetFileMetadata
GetFilesRequest

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.

GetFilesResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code

error

string

Playfab error code

errorCode

integer

Numerical PlayFab error code

errorDetails

object

Detailed description of individual issues with the request object

errorMessage

string

Description for the PlayFab errorCode

status

string

String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name Type Description
Id

string

Unique ID of the entity.

Type

string

Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

GetFileMetadata

Name Type Description
Checksum

string

Checksum value for the file, can be used to check if the file on the server has changed.

DownloadUrl

string

Download URL where the file can be retrieved

FileName

string

Name of the file

LastModified

string

Last UTC time the file was modified

Size

number

Storage service's reported byte count

GetFilesRequest

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.

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Entity

EntityKey

The entity to perform this action on.

GetFilesResponse

Name Type Description
Entity

EntityKey

The entity id and type.

Metadata

GetFileMetadata

Collection of metadata for the entity's files

ProfileVersion

number

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