Difference between revisions of "EfficientMetering/APIProposalv1"
| Line 3: | Line 3: | ||
* All results are provided JSON or OPENSTACK format. | * All results are provided JSON or OPENSTACK format. | ||
* [] denotes optional information | * [] denotes optional information | ||
| + | * date_time is assumed to use ISO format | ||
| + | * [start_time and end_time] are optional date_times for most of the request. It has previously been agreed that the range is exclusive for start and inclusive for end. | ||
{| border="1" cellpadding="2" cellspacing="0" | {| border="1" cellpadding="2" cellspacing="0" | ||
| Line 43: | Line 45: | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]LIST/RESOURCES | | v1/[SOURCES/<SOURCE>/]LIST/RESOURCES | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS | | v1/[SOURCES/<SOURCE>/]USERS | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS/<USER_ID> | | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID> | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER> | | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER> | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER>/VOLUME | | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER>/VOLUME | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER>/DURATION | | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER>/DURATION | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES | | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/ | | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/ | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER> | | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER> | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER>/VOLUME | | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER>/VOLUME | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER>/DURATION | | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER>/DURATION | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS | | v1/[SOURCES/<SOURCE>/]PROJECTS | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID> | | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID> | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER> | | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER> | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER>/VOLUME | | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER>/VOLUME | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER>/DURATION | | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER>/DURATION | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES | | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/ | | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/ | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER> | | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER> | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER>/VOLUME | | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER>/VOLUME | ||
| − | | [ | + | | [start_time and end_time] |
|- | |- | ||
| GET | | GET | ||
| v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER>/DURATION | | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER>/DURATION | ||
| − | | [ | + | | [start_time and end_time] |
Revision as of 18:17, 16 May 2012
Notes:
- All results are provided JSON or OPENSTACK format.
- [] denotes optional information
- date_time is assumed to use ISO format
- [start_time and end_time] are optional date_times for most of the request. It has previously been agreed that the range is exclusive for start and inclusive for end.
| Verb | URL | Parameters |
| GET | v1 | - |
| GET | v1/EXTENSIONS | - |
| GET | v1/EXTENSIONS/<ALIAS> | - |
| GET | v1/SOURCES | [JSON Start/End time stamps] |
| GET | v1/[SOURCES/<SOURCE>/]LIST | - |
| GET | v1/[SOURCES/<SOURCE>/]LIST/COMPONENTS | - |
| GET | v1/[SOURCES/<SOURCE>/]LIST/<COMPONENT>/METERS | - |
| GET | v1/[SOURCES/<SOURCE>/]LIST/METERS | - |
| GET | v1/[SOURCES/<SOURCE>/]LIST/RESOURCES | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID> | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER> | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER>/VOLUME | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER>/DURATION | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/ | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER> | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER>/VOLUME | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER>/DURATION | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID> | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER> | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER>/VOLUME | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER>/DURATION | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/ | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER> | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER>/VOLUME | [start_time and end_time] |
| GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER>/DURATION | [start_time and end_time] |
