UsageAdapterManager

The type is used to implement Charge Import API

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "UsageAdapterManager",
  "id": "http://com.odin.rating/usage-adapter-manager/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "operations": {
    "processUsageReports": {
      "path": "usageReports",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    },
    "getUsageReports": {
      "path": "usageReportsList",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "getReportErrors": {
      "path": "errorList",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "reportId": {
          "kind": "query",
          "type": "string"
        },
        "productId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "getReportTemplate": {
      "path": "/usageReportTemplate",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
processUsageReports	POST	/usageReports
getUsageReports	GET	/usageReportsList
getReportErrors	GET	/errorList
getReportTemplate	GET	/usageReportTemplate

processUsageReports

HTTP Request

POST /aps/2/resources/{aps-id}/usageReports

Description

Returns

getUsageReports

HTTP Request

GET /aps/2/resources/{aps-id}/usageReportsList

Description

Returns

getReportErrors

HTTP Request

GET /aps/2/resources/{aps-id}/errorList

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
reportId	String
productId	String

Returns

getReportTemplate

HTTP Request

GET /aps/2/resources/{aps-id}/usageReportTemplate

Description

Returns

Examples

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← Margin

Configuration Management →