File - Initiate File Uploads
Initiates file uploads to an entity's profile.
POST https://titleId.playfabapi.com/File/InitiateFileUploadsRequest 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 |
The entity to perform this action on. |
|
| FileNames | True |
string[] |
Names of the files to be set. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
| ProfileVersion |
number |
The expected version of the profile, if set and doesn't match the current version of the profile the operation will not be performed. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Initiate |
|
|
Initiate |
Returns URLs that may be used to upload the files for a profile 5 minutes. After using the upload calls FinalizeFileUploads must be called to move the file status from pending to live. |
|
Initiate |
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 |
InitiateFileUploadMetadata
| Name | Type | Description |
|---|---|---|
| FileName |
string |
Name of the file. |
| UploadUrl |
string |
Location the data should be sent to via an HTTP PUT operation. |
InitiateFileUploadsRequest
Returns URLs that may be used to upload the files for a profile 5 minutes. After using the upload calls FinalizeFileUploads must be called to move the file status from pending to live.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Entity |
The entity to perform this action on. |
|
| FileNames |
string[] |
Names of the files to be set. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' |
| ProfileVersion |
number |
The expected version of the profile, if set and doesn't match the current version of the profile the operation will not be performed. |
InitiateFileUploadsResponse
| Name | Type | Description |
|---|---|---|
| Entity |
The entity id and type. |
|
| ProfileVersion |
number |
The current version of the profile, can be used for concurrency control during updates. |
| UploadDetails |
Collection of file names and upload urls |
Error Codes
| Name | Code |
|---|---|
| EntityFileOperationPending | 1350 |