Configuration API

Configuration API

This is the final 1.0 version of the Configuration API

/configurations/

• GET: returns JSON representation of all Configuration objects

  • payload: none

  • success: 200

      {
        "barconf1": {
          "created_at": "2011-04-27 01:20:37 UTC",
          "format": "string",
          "body": "barbody1",
          "updated_at": "2011-04-27 01:20:37 UTC",
          "tags": [
    
          ],
          "id": "aa183dce-30ec-2d7e-c6f9-f3385161a7e6",
          "links": [
    
          ]
        },
        "barconf2": {
          "created_at": "2011-04-27 01:24:40 UTC",
          "format": "string",
          "body": "barbody2",
          "updated_at": "2011-04-27 01:24:40 UTC",
          "tags": [
    
          ],
          "id": "4cd77d03-bc94-e52a-9613-8676ec217ee0",
          "links": [
    
          ]
        },
        "barconf": {
          "created_at": "2011-04-27 01:20:14 UTC",
          "format": "string",
          "body": "barbody",
          "updated_at": "2011-04-27 01:20:14 UTC",
          "tags": [
    
          ],
          "id": "abc6d24e-5af9-7916-3373-160e6c1db227",
          "links": [
    
          ]
        }
      }
    

  • failure: 404

  • error: 500

• PUT: not supported. Possible future support for bulk operations

• POST: not supported. Possible future support for bulk operations

• DELETE: not supported.

/configurations/configname

• GET: returns JSON or raw representation of named Configuration

  • payload: Using a custom header of Accept: application/json will return the JSON representation Using any other custom Accept header will return the raw object. By default, most clients will send Accept: */* in the request. This will result in the JSON representation EVERY time. If you wish to get the raw data, the best way to ensure that is to send Accept: application/octet

  • success: 200

      {
        "name": "barconf",
        "created_at": "2011-04-27 01:20:14 UTC",
        "format": "string",
        "body": "barbody",
        "updated_at": "2011-04-27 01:20:14 UTC",
        "tags": [
    
        ],
        "id": "abc6d24e-5af9-7916-3373-160e6c1db227",
        "links": [
    
        ]
      }
    

  • failure: 404

  • error: 500

• PUT: Creates or updates the named Configuration object

  • payload: {"format":"format_type","body":"body of item"}

  • success: 200

      {
        "result": "success",
        "action": "create",
        "id": "b1a1fa2c-bd5c-7f87-9a9f-8dbbc89def5a",
        "item": "myfunconf"
      }
    

  • failure: 404

  • error: 500

• POST: Not supported.

• DELETE: Deletes named Configuration object and removes it from any Applications using it

  • payload: none

  • success: 200

      {
        "result": "success",
        "action": "delete",
        "affected_applications": [
          "barapp2"
        ],
        "id": "37ebd05b-d48c-3995-453b-c0fe4fe58a5f",
        "item": "barconf4"
      }
    

  • failure: 404

  • error: 500