Outbound Integration Monitoring API

Metadata

metadataGet

View the EDMX document for OutboundIntegrationMonitoring Integration Objects.

Requests for EDMX documents. The metadata is an Entity Data Model XML (EDMX) document that describes the entity types and their properties.


/$metadata

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/xml"\
"https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/$metadata"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetadataApi;

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

public class MetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        MetadataApi apiInstance = new MetadataApi();
        try {
            apiInstance.metadataGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling MetadataApi#metadataGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetadataApi;

public class MetadataApiExample {

    public static void main(String[] args) {
        MetadataApi apiInstance = new MetadataApi();
        try {
            apiInstance.metadataGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling MetadataApi#metadataGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// View the EDMX document for OutboundIntegrationMonitoring Integration Objects.
[apiInstance metadataGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OutboundIntegrationMonitoringApi = require('outbound_integration_monitoring_api');
var defaultClient = OutboundIntegrationMonitoringApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new OutboundIntegrationMonitoringApi.MetadataApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.metadataGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class metadataGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MetadataApi();

            try
            {
                // View the EDMX document for OutboundIntegrationMonitoring Integration Objects.
                apiInstance.metadataGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetadataApi.metadataGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiMetadataApi();

try {
    $api_instance->metadataGet();
} catch (Exception $e) {
    echo 'Exception when calling MetadataApi->metadataGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetadataApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::MetadataApi->new();

eval { 
    $api_instance->metadataGet();
};
if ($@) {
    warn "Exception when calling MetadataApi->metadataGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.MetadataApi()

try: 
    # View the EDMX document for OutboundIntegrationMonitoring Integration Objects.
    api_instance.metadata_get()
except ApiException as e:
    print("Exception when calling MetadataApi->metadataGet: %s\n" % e)

Parameters

Responses

Status: 200 - A valid EDMX schema.

Status: 401 - Unauthorized exception responses.

Status: 403 - Forbidden exception responses.


OutboundRequests

outboundRequestsGet

View OutboundRequests.

Retrieves OutboundRequests.


/OutboundRequests

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/OutboundRequests?$top=&$skip=&$filter=&$inlinecount=&$expand="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OutboundRequestsApi;

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

public class OutboundRequestsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        OutboundRequestsApi apiInstance = new OutboundRequestsApi();
        Integer $top = 56; // Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
        Integer $skip = 56; // Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
        String $filter = $filter_example; // String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
        String $inlinecount = ; // String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
        String $expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
        try {
            Wrapper result = apiInstance.outboundRequestsGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundRequestsApi#outboundRequestsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OutboundRequestsApi;

public class OutboundRequestsApiExample {

    public static void main(String[] args) {
        OutboundRequestsApi apiInstance = new OutboundRequestsApi();
        Integer $top = 56; // Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
        Integer $skip = 56; // Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
        String $filter = $filter_example; // String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
        String $inlinecount = ; // String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
        String $expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
        try {
            Wrapper result = apiInstance.outboundRequestsGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundRequestsApi#outboundRequestsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *$top = 56; // The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional)
Integer *$skip = 56; // The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional)
String *$filter = $filter_example; // A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html) (optional)
String *$inlinecount = ; // Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html) (optional)
String *$expand = $expand_example; // Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional)

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

// View OutboundRequests.
[apiInstance outboundRequestsGetWith:$top
    $skip:$skip
    $filter:$filter
    $inlinecount:$inlinecount
    $expand:$expand
              completionHandler: ^(Wrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OutboundIntegrationMonitoringApi = require('outbound_integration_monitoring_api');
var defaultClient = OutboundIntegrationMonitoringApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new OutboundIntegrationMonitoringApi.OutboundRequestsApi()
var opts = { 
  '$top': 56, // {{Integer}} The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
  '$skip': 56, // {{Integer}} The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
  '$filter': $filter_example, // {{String}} A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
  '$inlinecount': , // {{String}} Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
  '$expand': $expand_example // {{String}} Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.outboundRequestsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class outboundRequestsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new OutboundRequestsApi();
            var $top = 56;  // Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional) 
            var $skip = 56;  // Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional) 
            var $filter = $filter_example;  // String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html) (optional) 
            var $inlinecount = new String(); // String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html) (optional) 
            var $expand = $expand_example;  // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional) 

            try
            {
                // View OutboundRequests.
                Wrapper result = apiInstance.outboundRequestsGet($top, $skip, $filter, $inlinecount, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutboundRequestsApi.outboundRequestsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiOutboundRequestsApi();
$$top = 56; // Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
$$skip = 56; // Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
$$filter = $filter_example; // String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
$$inlinecount = ; // String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
$$expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

try {
    $result = $api_instance->outboundRequestsGet($$top, $$skip, $$filter, $$inlinecount, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutboundRequestsApi->outboundRequestsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OutboundRequestsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::OutboundRequestsApi->new();
my $$top = 56; # Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
my $$skip = 56; # Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
my $$filter = $filter_example; # String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
my $$inlinecount = ; # String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
my $$expand = $expand_example; # String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

eval { 
    my $result = $api_instance->outboundRequestsGet($top => $$top, $skip => $$skip, $filter => $$filter, $inlinecount => $$inlinecount, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutboundRequestsApi->outboundRequestsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OutboundRequestsApi()
$top = 56 # Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional)
$skip = 56 # Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional)
$filter = $filter_example # String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html) (optional)
$inlinecount =  # String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html) (optional)
$expand = $expand_example # String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional)

try: 
    # View OutboundRequests.
    api_response = api_instance.outbound_requests_get($top=$top, $skip=$skip, $filter=$filter, $inlinecount=$inlinecount, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutboundRequestsApi->outboundRequestsGet: %s\n" % e)

Parameters

Query parameters
Name Description
$top
Integer
The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
$skip
Integer
The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
$filter
String
A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
$inlinecount
String
Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
$expand
String
Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

Responses

Status: 200 - Retrieved entities.

Status: 400 - Error responses that may occur due to an exception related to the filter query parameter.

Status: 401 - Unauthorized exception responses.

Status: 403 - Forbidden exception responses.

Status: 404 - An error response that may occur when the requested property is not defined on the OutboundRequest EntityType.


outboundRequestsIntegrationKeyGet

View an individual OutboundRequest.

Retrieves an OutboundRequest by its integrationKey.


/OutboundRequests(%27{integrationKey}%27)

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/OutboundRequests(%27{integrationKey}%27)?$expand="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OutboundRequestsApi;

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

public class OutboundRequestsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        OutboundRequestsApi apiInstance = new OutboundRequestsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String $expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
        try {
            OutboundRequest_1 result = apiInstance.outboundRequestsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundRequestsApi#outboundRequestsIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OutboundRequestsApi;

public class OutboundRequestsApiExample {

    public static void main(String[] args) {
        OutboundRequestsApi apiInstance = new OutboundRequestsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String $expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
        try {
            OutboundRequest_1 result = apiInstance.outboundRequestsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundRequestsApi#outboundRequestsIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *integrationKey = integrationKey_example; // key: integrationKey
String *$expand = $expand_example; // Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional)

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

// View an individual OutboundRequest.
[apiInstance outboundRequestsIntegrationKeyGetWith:integrationKey
    $expand:$expand
              completionHandler: ^(OutboundRequest_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OutboundIntegrationMonitoringApi = require('outbound_integration_monitoring_api');
var defaultClient = OutboundIntegrationMonitoringApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new OutboundIntegrationMonitoringApi.OutboundRequestsApi()
var integrationKey = integrationKey_example; // {{String}} key: integrationKey
var opts = { 
  '$expand': $expand_example // {{String}} Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.outboundRequestsIntegrationKeyGet(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class outboundRequestsIntegrationKeyGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new OutboundRequestsApi();
            var integrationKey = integrationKey_example;  // String | key: integrationKey
            var $expand = $expand_example;  // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional) 

            try
            {
                // View an individual OutboundRequest.
                OutboundRequest_1 result = apiInstance.outboundRequestsIntegrationKeyGet(integrationKey, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutboundRequestsApi.outboundRequestsIntegrationKeyGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiOutboundRequestsApi();
$integrationKey = integrationKey_example; // String | key: integrationKey
$$expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

try {
    $result = $api_instance->outboundRequestsIntegrationKeyGet($integrationKey, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutboundRequestsApi->outboundRequestsIntegrationKeyGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OutboundRequestsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::OutboundRequestsApi->new();
my $integrationKey = integrationKey_example; # String | key: integrationKey
my $$expand = $expand_example; # String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

eval { 
    my $result = $api_instance->outboundRequestsIntegrationKeyGet(integrationKey => $integrationKey, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutboundRequestsApi->outboundRequestsIntegrationKeyGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OutboundRequestsApi()
integrationKey = integrationKey_example # String | key: integrationKey
$expand = $expand_example # String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional)

try: 
    # View an individual OutboundRequest.
    api_response = api_instance.outbound_requests_integration_key_get(integrationKey, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutboundRequestsApi->outboundRequestsIntegrationKeyGet: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
key: integrationKey
Required
Query parameters
Name Description
$expand
String
Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

Responses

Status: 200 - Retrieved entity.

Status: 400 - An error occurred because the format of the integrationKey does not match the same format that the EntityType's integration key format is in.

Status: 401 - Unauthorized exception responses.

Status: 403 - Forbidden exception responses.

Status: 404 - Not Found exception responses for GET operations.


outboundRequestscountGet

View the count of all OutboundRequests.

Displays the total count of all OutboundRequests.


/OutboundRequests/$count

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: text/plain"\
"https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/OutboundRequests/$count"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OutboundRequestsApi;

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

public class OutboundRequestsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        OutboundRequestsApi apiInstance = new OutboundRequestsApi();
        try {
            'String' result = apiInstance.outboundRequestscountGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundRequestsApi#outboundRequestscountGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OutboundRequestsApi;

public class OutboundRequestsApiExample {

    public static void main(String[] args) {
        OutboundRequestsApi apiInstance = new OutboundRequestsApi();
        try {
            'String' result = apiInstance.outboundRequestscountGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundRequestsApi#outboundRequestscountGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// View the count of all OutboundRequests.
[apiInstance outboundRequestscountGetWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OutboundIntegrationMonitoringApi = require('outbound_integration_monitoring_api');
var defaultClient = OutboundIntegrationMonitoringApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new OutboundIntegrationMonitoringApi.OutboundRequestsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.outboundRequestscountGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class outboundRequestscountGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new OutboundRequestsApi();

            try
            {
                // View the count of all OutboundRequests.
                'String' result = apiInstance.outboundRequestscountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutboundRequestsApi.outboundRequestscountGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiOutboundRequestsApi();

try {
    $result = $api_instance->outboundRequestscountGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutboundRequestsApi->outboundRequestscountGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OutboundRequestsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::OutboundRequestsApi->new();

eval { 
    my $result = $api_instance->outboundRequestscountGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutboundRequestsApi->outboundRequestscountGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OutboundRequestsApi()

try: 
    # View the count of all OutboundRequests.
    api_response = api_instance.outbound_requestscount_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutboundRequestsApi->outboundRequestscountGet: %s\n" % e)

Parameters

Responses

Status: 200 - A success response displaying the total count of OutboundRequests.