Advanced Action API


A resource action is – in fact – a state transition. This API example demonstrates an action - state transition - to another resource.

API Blueprint

Tasks

List All Tasks

REQUEST

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
    {
        "id": 123,
        "name": "Exercise in gym",
        "done": false,
        "type": "task"
    },
    {
        "id": 124,
        "name": "Shop for groceries",
        "done": true,
        "type": "task"
    }
]

                      
                        
                      

Retrieve Task

This is a state transition to another resource.

REQUEST

Parameters
id string -

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
    "id": 123,
    "name": "Go to gym",
    "done": false,
    "type": "task"
}

                      
                        
                      

Delete Task

REQUEST

Parameters
id string -

RESPONSE

Headers