Get the project status of an existing file sync project

Prev Next
Get
/v{version}/FileSync/Projects/{projectId}/Status

Projects are implicitly filtered by the user's read permission.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
projectId
integer (int32) Required

Unique ID of the file sync project

version
stringRequired

The requested API version

Default"1.17"
Query parameters
locationId
integer (int32)

Unique ID of the location

Responses
200

OK

Array of object
object

Player status of a file sync project

PlayerId
integer (int32)

Unique ID of the player

LocationId
integer (int32)

Unique ID of the location assigned to the player

PlayerName
string

Name of the player

BoxId
string

Box ID of the player

CustomId
string

Custom ID of the player

ProjectId
integer (int32)

Unique ID of the file sync project

ProjectVersion
string

Version of the file sync project

CommittedVersion
string

Version of the last project committed to the player

Committed
string (date-time)

Last time a project was committed to the player in UTC

LastRequestVersion
string

Version of the last project requested by the player

LastRequest
string (date-time)

Last time a project was request by the player in UTC

ErrorVersion
string

Version of the last project that failed to sync

ErrorReceived
string (date-time)

Date of the last time an sync error was received in UTC

Status
object (V1.Models.FileSync.FileSyncTransferStatus)

Player's transfer status

TotalFileCount
integer (int32)

Total amount of files of the sync

TransferredFileCount
integer (int32)

Amount of transferred files

TotalBytes
integer (int64)

Amount of bytes of the total of files

TransferredBytes
integer (int64)

Amount of bytes of the transferred files

BytesPerSecond
number (double)

Amount of transferred bytes per second

LastStatusUpdate
string (date-time)

Time of the last status update in UTC

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Type
string
Message
string
Values
object
property*
object additionalProperties
404

Project or its UDC plugin container not found

500

Unexpected error

Expand All
object
Id
string
Type
string
Message
string
Values
object
property*
object additionalProperties