Usage Consumption TMF Webservices API

UsageConsumptionReport

listUsageConsumptionReport

List or find UsageConsumptionReport objects

This operation list or find UsageConsumptionReport entities


/usageConsumptionReport

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/usageconsumptiontmfwebservices/v1/usageConsumptionReport?fields=&limit=&offset=&product.id=&publicIdentifier=&relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsageConsumptionReportApi;

import java.io.File;
import java.util.*;

public class UsageConsumptionReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        UsageConsumptionReportApi apiInstance = new UsageConsumptionReportApi();
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String product.id = product.id_example; // String | Network product id value
        String publicIdentifier = publicIdentifier_example; // String | Public identifier value
        String relatedParty.id = relatedParty.id_example; // String | Related party id value
        try {
            array[UsageConsumptionReport] result = apiInstance.listUsageConsumptionReport(fields, limit, offset, product.id, publicIdentifier, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsageConsumptionReportApi#listUsageConsumptionReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsageConsumptionReportApi;

public class UsageConsumptionReportApiExample {

    public static void main(String[] args) {
        UsageConsumptionReportApi apiInstance = new UsageConsumptionReportApi();
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String product.id = product.id_example; // String | Network product id value
        String publicIdentifier = publicIdentifier_example; // String | Public identifier value
        String relatedParty.id = relatedParty.id_example; // String | Related party id value
        try {
            array[UsageConsumptionReport] result = apiInstance.listUsageConsumptionReport(fields, limit, offset, product.id, publicIdentifier, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsageConsumptionReportApi#listUsageConsumptionReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *fields = fields_example; // Comma-separated properties to be provided in response (optional)
Integer *limit = 56; // Requested number of resources to be provided in response (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response (optional)
String *product.id = product.id_example; // Network product id value (optional)
String *publicIdentifier = publicIdentifier_example; // Public identifier value (optional)
String *relatedParty.id = relatedParty.id_example; // Related party id value (optional)

UsageConsumptionReportApi *apiInstance = [[UsageConsumptionReportApi alloc] init];

// List or find UsageConsumptionReport objects
[apiInstance listUsageConsumptionReportWith:fields
    limit:limit
    offset:offset
    product.id:product.id
    publicIdentifier:publicIdentifier
    relatedParty.id:relatedParty.id
              completionHandler: ^(array[UsageConsumptionReport] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UsageConsumptionTmfWebservicesApi = require('usage_consumption_tmf_webservices_api');
var defaultClient = UsageConsumptionTmfWebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new UsageConsumptionTmfWebservicesApi.UsageConsumptionReportApi()
var opts = { 
  'fields': fields_example, // {{String}} Comma-separated properties to be provided in response
  'limit': 56, // {{Integer}} Requested number of resources to be provided in response
  'offset': 56, // {{Integer}} Requested index for start of resources to be provided in response
  'product.id': product.id_example, // {{String}} Network product id value
  'publicIdentifier': publicIdentifier_example, // {{String}} Public identifier value
  'relatedParty.id': relatedParty.id_example // {{String}} Related party id value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUsageConsumptionReport(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listUsageConsumptionReportExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UsageConsumptionReportApi();
            var fields = fields_example;  // String | Comma-separated properties to be provided in response (optional) 
            var limit = 56;  // Integer | Requested number of resources to be provided in response (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response (optional) 
            var product.id = product.id_example;  // String | Network product id value (optional) 
            var publicIdentifier = publicIdentifier_example;  // String | Public identifier value (optional) 
            var relatedParty.id = relatedParty.id_example;  // String | Related party id value (optional) 

            try
            {
                // List or find UsageConsumptionReport objects
                array[UsageConsumptionReport] result = apiInstance.listUsageConsumptionReport(fields, limit, offset, product.id, publicIdentifier, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsageConsumptionReportApi.listUsageConsumptionReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUsageConsumptionReportApi();
$fields = fields_example; // String | Comma-separated properties to be provided in response
$limit = 56; // Integer | Requested number of resources to be provided in response
$offset = 56; // Integer | Requested index for start of resources to be provided in response
$product.id = product.id_example; // String | Network product id value
$publicIdentifier = publicIdentifier_example; // String | Public identifier value
$relatedParty.id = relatedParty.id_example; // String | Related party id value

try {
    $result = $api_instance->listUsageConsumptionReport($fields, $limit, $offset, $product.id, $publicIdentifier, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsageConsumptionReportApi->listUsageConsumptionReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsageConsumptionReportApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UsageConsumptionReportApi->new();
my $fields = fields_example; # String | Comma-separated properties to be provided in response
my $limit = 56; # Integer | Requested number of resources to be provided in response
my $offset = 56; # Integer | Requested index for start of resources to be provided in response
my $product.id = product.id_example; # String | Network product id value
my $publicIdentifier = publicIdentifier_example; # String | Public identifier value
my $relatedParty.id = relatedParty.id_example; # String | Related party id value

eval { 
    my $result = $api_instance->listUsageConsumptionReport(fields => $fields, limit => $limit, offset => $offset, product.id => $product.id, publicIdentifier => $publicIdentifier, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsageConsumptionReportApi->listUsageConsumptionReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UsageConsumptionReportApi()
fields = fields_example # String | Comma-separated properties to be provided in response (optional)
limit = 56 # Integer | Requested number of resources to be provided in response (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response (optional)
product.id = product.id_example # String | Network product id value (optional)
publicIdentifier = publicIdentifier_example # String | Public identifier value (optional)
relatedParty.id = relatedParty.id_example # String | Related party id value (optional)

try: 
    # List or find UsageConsumptionReport objects
    api_response = api_instance.list_usage_consumption_report(fields=fields, limit=limit, offset=offset, product.id=product.id, publicIdentifier=publicIdentifier, relatedParty.id=relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsageConsumptionReportApi->listUsageConsumptionReport: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Comma-separated properties to be provided in response
limit
Integer (int32)
Requested number of resources to be provided in response
offset
Integer (int32)
Requested index for start of resources to be provided in response
product.id
String
Network product id value
publicIdentifier
String
Public identifier value
relatedParty.id
String
Related party id value

Responses

Status: 200 - Success

Status: 206 - Partial Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error