Aggregator Settings (v1)

http://localhost/erm-usage-harvester

Table of contents

mod-erm-usage API

This documents the API calls that can be made to query and manage aggregator settings

/erm-usage-harvester

GET /erm-usage-harvester/settings

Get settings for tenant

GET /erm-usage-harvester/settings

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Harvester Setting Schema",
  "description": "Global settings for harvester (not used yet)",
  "type": "object",
  "properties": {
    "username": {
      "description": "username",
      "type": "string"
    },
    "password": {
      "description": "password",
      "type": "string"
    }
  },
  "required": [
    "username",
    "password"
  ],
  "additionalProperties": true
}

POST /erm-usage-harvester/settings

Set settings for tenant

POST /erm-usage-harvester/settings
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Harvester Setting Schema",
  "description": "Global settings for harvester (not used yet)",
  "type": "object",
  "properties": {
    "username": {
      "description": "username",
      "type": "string"
    },
    "password": {
      "description": "password",
      "type": "string"
    }
  },
  "required": [
    "username",
    "password"
  ],
  "additionalProperties": true
}

DELETE /erm-usage-harvester/settings

Delete settings for tenant

DELETE /erm-usage-harvester/settings

GET /erm-usage-harvester/start

Start harvesting for tenant - process all defined usage data providers

GET /erm-usage-harvester/start

GET /erm-usage-harvester/start/{id}

Start harvesting for tenant - process a specific usage data provider only

GET /erm-usage-harvester/start/{id}
URI Parameters
  • id: required (string)

GET /erm-usage-harvester/impl

Get available service implementations

GET /erm-usage-harvester/impl
Query Parameters
  • aggregator: (string)

    Filter by 'isAggregator' property (true or false)