Documentation

GetTasks

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

Request Details

GetTasksRequest
Request Properties
Identifier NameIdentifier

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

POST https://{{TitleID}}.playfabapi.com/Admin/GetTasks
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "Identifier": {
    "Name": "EnableDailyHappyHour"
  }
}
        

Response Details

GetTasksResult
Result Properties
Tasks List<ScheduledTask>

Result tasks. Empty if there is no task found.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Tasks": [
      {
        "TaskId": "9742767689DA713",
        "Name": "EnableDailyHappyHour",
        "Description": "Turn on special pricing for weekday happy-hour",
        "Schedule": "0 17 * * 1-5",
        "IsActive": false,
        "Type": "CloudScript",
        "Parameter": {
          "FunctionName": "applyStorePreset",
          "Argument": {
            "preset": "WeekdayHappyHour"
          }
        },
        "LastRunTime": "2016-10-19T05:43:19Z",
        "NextRunTime": "2016-10-19T17:00:00Z"
      }
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code