An error occured. Details Hide
You have unsaved pages. Restore Cancel

Dimension Group

This endpoint used to list/add/edit/delete groups in dimensions. The functionality of endpoint depends on HTTP method: GET, POST, PUT or DELETE.

 

Input

List group (GET method)

Group key - group key to be listed, specified through <groupKey> URL parameter

Add group (POST method)

Group descriptor - group definition in JSON format specified through request body

Edit group (PUT method)

Group key - group key to be modified, specified through <groupKey> URL parameter

Group descriptor - updated group definition in JSON format specified through request body

Delete group (DELETE method)

Group key - group key to be deleted, specified through <groupKey> URL parameter

 

Result

200 OK - operation was completed successfully

201 Created - new group was created successfully, returns group key for created group

400 Bad Request - group descriptor is not valid

403 Forbidden - user doesn't have permissions to perform operation

404 Not Found - specified group key is not valid

 

Example

List

GET http://knoema.com/api/1.0/meta/group/435435
  
200 OK
  
{
    DimensionId: "Country",
    Id: "WDI2010",
    Name: "BRIC",
    Members: [
        45,
        345,
        235,
        342
    ]
}

Add

POST http://knoema.com/api/1.0/meta/group
{
    DimensionId: "Country",
    Id: "WDI2010",
    Name: "BRIC",
    Members: [
        45,
        345,
        235,
        342
    ]
}
  
201 Created
  
{
    GroupKey: 3223
}

Edit

PUT http://knoema.com/api/1.0/meta/group/435435
  
{
     DimensionId: "Country",
     Id: "WDI2010",
     Name: "BRIC",
     Members: [
        45,
        345,
        235,
        342
     ]
}
  
200 OK

Delete

DELETE http://knoema.com/api/1.0/meta/group/2523
  
404 Not Found