ConfigurationController Resource

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

DELETE /user/v1.0/deployer/configuration/all

Deletes all entries. Use with caution !

Security Roles Allowed
ADMIN
Response Codes
code condition
200 Successful delete
401 Bad credentials
Response Body
media type data type
application/json string (JSON)
application/xml string (XML)

Example

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

                
...

GET /user/v1.0/deployer/configuration/ids

Gets the IDs of all the stored PlayBook descriptions.

Security Roles Allowed
ADMIN, USER
Response Codes
code condition
200 Successful query
401 Bad credentials
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/deployer/configuration/ids
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
...

POST /user/v1.0/deployer/configuration/post

Post a deployment configuration.

Security Roles Allowed
ADMIN, USER
Request Body
media type data type
application/json string (JSON)
application/xml string (XML)
Response Codes
code condition
200 Successful post
400 contents are not valid (e.g. not a yaml format)
401 Bad credentials
Response Body
media type data type
application/json string (JSON)
application/xml string (XML)

Example

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

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

                
...

POST /user/v1.0/deployer/configuration/upload

Uploads and stores a PlayBook description file

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description constraints
file query   required
Response Codes
code condition
200 Successful upload
400 Didn't upload (multipart) file or contents are not valid (e.g. not a yaml format)
401 Bad credentials
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/deployer/configuration/upload
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
...

DELETE /user/v1.0/deployer/configuration/{id}

Deletes the PlayBook description.

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description constraints
id path   required
Response Codes
code condition
200 Successful delete
404 Object not found
401 Bad credentials
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/deployer/configuration/{id}
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
...

GET /user/v1.0/deployer/configuration/{id}

Gets the PlayBook description.

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description constraints
id path the ID PlayBook description. required
format query   required
Response Codes
code condition
200 Object found
400 contents are not valid (e.g. not a yaml format)
404 Object not found
401 Bad credentials
Response Body
media type data type description
application/json string (JSON) the PlayBook description.
application/xml string (XML)

Example

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

                
...