Freigeben über


Catalog - Publish Draft Item

Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API to track the state of the item publish.

POST https://titleId.playfabapi.com/Catalog/PublishDraftItem

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 Type Description
AlternateId

CatalogAlternateId

An alternate ID associated with this item.

CustomTags

object

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

ETag

string

ETag of the catalog item to published from the working catalog to the public catalog. Used for optimistic concurrency. If the provided ETag does not match the ETag in the current working catalog, the request will be rejected. If not provided, the current version of the document in the working catalog will be published.

Entity

EntityKey

The entity to perform this action on.

Id

string

The unique ID of the item.

Responses

Name Type Description
200 OK

PublishDraftItemResponse

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

CatalogAlternateId
EntityKey

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

PublishDraftItemRequest

The call kicks off a workflow to publish the item to the public catalog. The Publish Status API should be used to monitor the publish job.

PublishDraftItemResponse

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

CatalogAlternateId

Name Type Description
Type

string

Type of the alternate ID.

Value

string

Value of the alternate ID.

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

PublishDraftItemRequest

The call kicks off a workflow to publish the item to the public catalog. The Publish Status API should be used to monitor the publish job.

Name Type Description
AlternateId

CatalogAlternateId

An alternate ID associated with this item.

CustomTags

object

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

ETag

string

ETag of the catalog item to published from the working catalog to the public catalog. Used for optimistic concurrency. If the provided ETag does not match the ETag in the current working catalog, the request will be rejected. If not provided, the current version of the document in the working catalog will be published.

Entity

EntityKey

The entity to perform this action on.

Id

string

The unique ID of the item.

PublishDraftItemResponse

Error Codes

Name Code
DatabaseThroughputExceeded 1113
ItemNotFound 1047