Scheduled Task - Get Tasks

Service:

Admin

API Version:

240426

Get definition information on a specified task or all tasks within a title.

POST https://titleId.playfabapi.com/Admin/GetTasks

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Type	Description
Identifier	NameIdentifier	Provide either the task ID or the task name to get a specific task. If not specified, return all defined tasks.

Responses

Name	Type	Description
200 OK	GetTasksResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
GetTasksRequest
GetTasksResult
NameIdentifier	Identifier by either name or ID. Note that a name may change due to renaming, or reused after being deleted. ID is immutable and unique.
ScheduledTask
ScheduledTaskType

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

GetTasksRequest

Name	Type	Description
Identifier	NameIdentifier	Provide either the task ID or the task name to get a specific task. If not specified, return all defined tasks.

GetTasksResult

Name	Type	Description
Tasks	ScheduledTask[]	Result tasks. Empty if there is no task found.

NameIdentifier

Identifier by either name or ID. Note that a name may change due to renaming, or reused after being deleted. ID is immutable and unique.

Name	Type	Description
Id	string	Id Identifier, if present
Name	string	Name Identifier, if present

ScheduledTask

Name	Type	Description
Description	string	Description the task
IsActive	boolean	Whether the schedule is active. Inactive schedule will not trigger task execution.
LastRunTime	string	UTC time of last run
Name	string	Name of the task. This is a unique identifier for tasks in the title.
NextRunTime	string	UTC time of next run
Parameter	object	Task parameter. Different types of task have different parameter structure. See each task type's create API documentation for the details.
Schedule	string	Cron expression for the run schedule of the task. The expression should be in UTC.
TaskId	string	ID of the task
Type	ScheduledTaskType	Task type.

ScheduledTaskType

Name	Type	Description
ActionsOnPlayerSegment	string
CloudScript	string
CloudScriptAzureFunctions	string
InsightsScheduledScaling	string