GET /processes/:processId

Description

Get the current state information of a process.

For more information on the structure of process state check out Process Basics

Resource URL

https://api.playlyfe.com/processes/:processId

Method

GET

Scopes

player, game, debug

Parameters

LocationParameter NameDefault ValueDescription
QueryprocessIdThe process ID

Example

Request
GET https://api.playlyfe.com/processes/neo/5312096a8e1ebb4550a6a6f8
Response
{
  "id": "neo/5312096a8e1ebb4550a6a6f8",
  "definition": "destroy_evil",
  "state": "ACTIVE",
  "version": "ab4f01025698574f4b71d77fff3e1b74",
  "created": "2014-03-01T16:23:06.501Z",
  "name": "The Matrix",
  "access": "PRIVATE",
  "performers": {
    "neo": {
      "*": "owner"
    },
    "morpheus": {
      "~": "player"
    }
  },
  "collaborators": {},
  "keys": {
    "neo/5312096a8e1ebb4550a6a6f8": "destroy_evil"
  },
  "containers": {
    "destroy_evil": {
      "key": "neo/5312096a8e1ebb4550a6a6f8",
      "tokens": 1,
      "nodes": {
        "choose_your_path": {
          "enabled": true,
          "routes": {
            "try_to_save_the_world": false,
            "destroy_the_world": false,
            "let_it_burn": false
          },
          "tokens": 1
        }
      }
    }
  }
}