Object - Get Objects

Retrieves objects from an entity's profile.

POST https://titleId.playfabapi.com/Object/GetObjects

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

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.).

EscapeObject
  • boolean

Determines whether the object will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON object.

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

ApiErrorWrapper

The basic wrapper around every failed API response

EntityKey

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

GetObjectsRequest

Gets JSON objects from an entity profile and returns it.

GetObjectsResponse
ObjectResult

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

GetObjectsRequest

Gets JSON objects from an entity profile and returns it.

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.

EscapeObject
  • boolean

Determines whether the object will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON object.

GetObjectsResponse

Name Type Description
Entity

The entity id and type.

Objects

Requested objects that the calling entity has access to

ProfileVersion
  • number

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

ObjectResult

Name Type Description
DataObject
  • object

Un-escaped JSON object, if EscapeObject false or default.

EscapedDataObject
  • string

Escaped string JSON body of the object, if EscapeObject is true.

ObjectName
  • string

Name of the object. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'