PlayBookController Resource

This controller is responsible for storing PlayBook descriptions that can be used by the planner.

DELETE /user/v1.0/playbook/all

Gets the IDs of all the stored PlayBook descriptions.

Security Roles Allowed
ADMIN
Response Body
media type data type description
application/json string (JSON) a list of all the IDs
application/xml string (XML)

Example

Request
DELETE /user/v1.0/playbook/all
Accept: application/json
Response
HTTP/1.1 204 Looks Good
Content-Type: application/json

                
...

GET /user/v1.0/playbook/ids

Gets the IDs of all the stored PlayBook descriptions.

Security Roles Allowed
ADMIN, USER
Response Body
media type data type description
application/json array of string (JSON) a list of all the IDs
application/xml list of string (XML)

Example

Request
GET /user/v1.0/playbook/ids
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
...

POST /user/v1.0/playbook/post

Security Roles Allowed
ADMIN, USER
Request Body
media type data type
application/json string (JSON)
application/xml string (XML)
Response Body
media type data type
application/json string (JSON)
application/xml string (XML)

Example

Request
POST /user/v1.0/playbook/post
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Looks Good
Content-Type: application/json

                
...

POST /user/v1.0/playbook/upload

Uploads and stores a PlayBook description file

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description
file query  
Response Body
media type data type description
application/json string (JSON) the ID of the PlayBook description
application/xml string (XML)

Example

Request
POST /user/v1.0/playbook/upload
Accept: application/json
Response
HTTP/1.1 201 Looks Good
Content-Type: application/json

                
...

DELETE /user/v1.0/playbook/{id}

Deletes the PlayBook description.

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description
id path  
Response Body
media type data type description
application/json string (JSON) The ID of the deleted PlayBook description.
application/xml string (XML)

Example

Request
DELETE /user/v1.0/playbook/{id}
Accept: application/json
Response
HTTP/1.1 204 Looks Good
Content-Type: application/json

                
...

GET /user/v1.0/playbook/{id}

Gets the PlayBook description.

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description
id path the ID PlayBook description.
format query  
Response Body
media type data type description
application/json string (JSON) the PlayBook description.
application/xml string (XML)

Example

Request
GET /user/v1.0/playbook/{id}
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
...