Inbound Monitoring API

InboundRequests

inboundRequestsGet

Retrieves inbound requests.

Retrieves GET, POST, PATCH and DELETE requests received by any integration object endpoint in the Integration APIs.


/InboundRequests

Usage and SDK Samples

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

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

public class InboundRequestsApiExample {

    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");

        InboundRequestsApi apiInstance = new InboundRequestsApi();
        String acceptLanguage = acceptLanguage_example; // String | Header to specify the language localized data will be returned in.
        Integer $top = 56; // Integer | Maximum number of items to return. If the value is greater than or equal to the number of matching items existing in the  platform, all items are returned. If the value is less than the number of matching items in the platform, a subset  containing the maximum number of items is returned. For more information, see [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
        Integer $skip = 56; // Integer | Number of matching items to skip over before returning the result set. If the skip value is greater than the number of  matching items, no items are returned. For more information, see [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
        String $filter = $filter_example; // String | A predicate expression used to select a subset of the items identified by the resource path. For more information, 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 | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html).
        try {
            Wrapper result = apiInstance.inboundRequestsGet(acceptLanguage, $top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundRequestsApi#inboundRequestsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InboundRequestsApi;

public class InboundRequestsApiExample {

    public static void main(String[] args) {
        InboundRequestsApi apiInstance = new InboundRequestsApi();
        String acceptLanguage = acceptLanguage_example; // String | Header to specify the language localized data will be returned in.
        Integer $top = 56; // Integer | Maximum number of items to return. If the value is greater than or equal to the number of matching items existing in the  platform, all items are returned. If the value is less than the number of matching items in the platform, a subset  containing the maximum number of items is returned. For more information, see [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
        Integer $skip = 56; // Integer | Number of matching items to skip over before returning the result set. If the skip value is greater than the number of  matching items, no items are returned. For more information, see [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
        String $filter = $filter_example; // String | A predicate expression used to select a subset of the items identified by the resource path. For more information, 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 | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html).
        try {
            Wrapper result = apiInstance.inboundRequestsGet(acceptLanguage, $top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundRequestsApi#inboundRequestsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *acceptLanguage = acceptLanguage_example; // Header to specify the language localized data will be returned in. (optional)
Integer *$top = 56; // Maximum number of items to return. If the value is greater than or equal to the number of matching items existing in the  platform, all items are returned. If the value is less than the number of matching items in the platform, a subset  containing the maximum number of items is returned. For more information, see [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html). (optional)
Integer *$skip = 56; // Number of matching items to skip over before returning the result set. If the skip value is greater than the number of  matching items, no items are returned. For more information, see [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html). (optional)
String *$filter = $filter_example; // A predicate expression used to select a subset of the items identified by the resource path. For more information, 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; // Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html). (optional)

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

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

var api = new InboundMonitoringApi.InboundRequestsApi()
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Header to specify the language localized data will be returned in.
  '$top': 56, // {{Integer}} Maximum number of items to return. If the value is greater than or equal to the number of matching items existing in the  platform, all items are returned. If the value is less than the number of matching items in the platform, a subset  containing the maximum number of items is returned. For more information, see [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
  '$skip': 56, // {{Integer}} Number of matching items to skip over before returning the result set. If the skip value is greater than the number of  matching items, no items are returned. For more information, see [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
  '$filter': $filter_example, // {{String}} A predicate expression used to select a subset of the items identified by the resource path. For more information, 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}} Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, 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.inboundRequestsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InboundRequestsApi();
            var acceptLanguage = acceptLanguage_example;  // String | Header to specify the language localized data will be returned in. (optional) 
            var $top = 56;  // Integer | Maximum number of items to return. If the value is greater than or equal to the number of matching items existing in the  platform, all items are returned. If the value is less than the number of matching items in the platform, a subset  containing the maximum number of items is returned. For more information, see [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html). (optional) 
            var $skip = 56;  // Integer | Number of matching items to skip over before returning the result set. If the skip value is greater than the number of  matching items, no items are returned. For more information, see [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html). (optional) 
            var $filter = $filter_example;  // String | A predicate expression used to select a subset of the items identified by the resource path. For more information, 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 | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html). (optional) 

            try
            {
                // Retrieves inbound requests.
                Wrapper result = apiInstance.inboundRequestsGet(acceptLanguage, $top, $skip, $filter, $inlinecount, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundRequestsApi.inboundRequestsGet: " + 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\ApiInboundRequestsApi();
$acceptLanguage = acceptLanguage_example; // String | Header to specify the language localized data will be returned in.
$$top = 56; // Integer | Maximum number of items to return. If the value is greater than or equal to the number of matching items existing in the  platform, all items are returned. If the value is less than the number of matching items in the platform, a subset  containing the maximum number of items is returned. For more information, see [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
$$skip = 56; // Integer | Number of matching items to skip over before returning the result set. If the skip value is greater than the number of  matching items, no items are returned. For more information, see [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
$$filter = $filter_example; // String | A predicate expression used to select a subset of the items identified by the resource path. For more information, 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 | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html).

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

my $api_instance = WWW::SwaggerClient::InboundRequestsApi->new();
my $acceptLanguage = acceptLanguage_example; # String | Header to specify the language localized data will be returned in.
my $$top = 56; # Integer | Maximum number of items to return. If the value is greater than or equal to the number of matching items existing in the  platform, all items are returned. If the value is less than the number of matching items in the platform, a subset  containing the maximum number of items is returned. For more information, see [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
my $$skip = 56; # Integer | Number of matching items to skip over before returning the result set. If the skip value is greater than the number of  matching items, no items are returned. For more information, see [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
my $$filter = $filter_example; # String | A predicate expression used to select a subset of the items identified by the resource path. For more information, 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 | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html).

eval { 
    my $result = $api_instance->inboundRequestsGet(acceptLanguage => $acceptLanguage, $top => $$top, $skip => $$skip, $filter => $$filter, $inlinecount => $$inlinecount, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboundRequestsApi->inboundRequestsGet: $@\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.InboundRequestsApi()
acceptLanguage = acceptLanguage_example # String | Header to specify the language localized data will be returned in. (optional)
$top = 56 # Integer | Maximum number of items to return. If the value is greater than or equal to the number of matching items existing in the  platform, all items are returned. If the value is less than the number of matching items in the platform, a subset  containing the maximum number of items is returned. For more information, see [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html). (optional)
$skip = 56 # Integer | Number of matching items to skip over before returning the result set. If the skip value is greater than the number of  matching items, no items are returned. For more information, see [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html). (optional)
$filter = $filter_example # String | A predicate expression used to select a subset of the items identified by the resource path. For more information, 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 | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html). (optional)

try: 
    # Retrieves inbound requests.
    api_response = api_instance.inbound_requests_get(acceptLanguage=acceptLanguage, $top=$top, $skip=$skip, $filter=$filter, $inlinecount=$inlinecount, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboundRequestsApi->inboundRequestsGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
String
Header to specify the language localized data will be returned in.
Query parameters
Name Description
$top
Integer
Maximum number of items to return. If the value is greater than or equal to the number of matching items existing in the platform, all items are returned. If the value is less than the number of matching items in the platform, a subset containing the maximum number of items is returned. For more information, see [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
$skip
Integer
Number of matching items to skip over before returning the result set. If the skip value is greater than the number of matching items, no items are returned. For more information, see [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html).
$filter
String
A predicate expression used to select a subset of the items identified by the resource path. For more information, 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
Navigation properties for the associated entries inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html).

Responses

Status: 200 - A collection of 0 or more InboundRequests.

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

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

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


inboundRequestsIntegrationKeyGet

Retrieves an inbound request.

Retrieves an inbound request by its integration key.


/InboundRequests(%27{integrationKey}%27)

Usage and SDK Samples

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

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

public class InboundRequestsApiExample {

    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");

        InboundRequestsApi apiInstance = new InboundRequestsApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity. The format of the integration key for the InboundRequest entity is  'InboundRequest_creationtime|InboundRequest_messageId|InboundRequest_requestIntegrationKey'.
        String acceptLanguage = acceptLanguage_example; // String | Header to specify the language localized data will be returned in.
        String $expand = $expand_example; // String | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html).
        try {
            Wrapper_1 result = apiInstance.inboundRequestsIntegrationKeyGet(integrationKey, acceptLanguage, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundRequestsApi#inboundRequestsIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InboundRequestsApi;

public class InboundRequestsApiExample {

    public static void main(String[] args) {
        InboundRequestsApi apiInstance = new InboundRequestsApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity. The format of the integration key for the InboundRequest entity is  'InboundRequest_creationtime|InboundRequest_messageId|InboundRequest_requestIntegrationKey'.
        String acceptLanguage = acceptLanguage_example; // String | Header to specify the language localized data will be returned in.
        String $expand = $expand_example; // String | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html).
        try {
            Wrapper_1 result = apiInstance.inboundRequestsIntegrationKeyGet(integrationKey, acceptLanguage, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundRequestsApi#inboundRequestsIntegrationKeyGet");
            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; // Unique identifier for an EDMX entity. The format of the integration key for the InboundRequest entity is  'InboundRequest_creationtime|InboundRequest_messageId|InboundRequest_requestIntegrationKey'.
String *acceptLanguage = acceptLanguage_example; // Header to specify the language localized data will be returned in. (optional)
String *$expand = $expand_example; // Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html). (optional)

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

// Retrieves an inbound request.
[apiInstance inboundRequestsIntegrationKeyGetWith:integrationKey
    acceptLanguage:acceptLanguage
    $expand:$expand
              completionHandler: ^(Wrapper_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboundMonitoringApi = require('inbound_monitoring_api');
var defaultClient = InboundMonitoringApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new InboundMonitoringApi.InboundRequestsApi()
var integrationKey = integrationKey_example; // {{String}} Unique identifier for an EDMX entity. The format of the integration key for the InboundRequest entity is  'InboundRequest_creationtime|InboundRequest_messageId|InboundRequest_requestIntegrationKey'.
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Header to specify the language localized data will be returned in.
  '$expand': $expand_example // {{String}} Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, 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.inboundRequestsIntegrationKeyGet(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InboundRequestsApi();
            var integrationKey = integrationKey_example;  // String | Unique identifier for an EDMX entity. The format of the integration key for the InboundRequest entity is  'InboundRequest_creationtime|InboundRequest_messageId|InboundRequest_requestIntegrationKey'.
            var acceptLanguage = acceptLanguage_example;  // String | Header to specify the language localized data will be returned in. (optional) 
            var $expand = $expand_example;  // String | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html). (optional) 

            try
            {
                // Retrieves an inbound request.
                Wrapper_1 result = apiInstance.inboundRequestsIntegrationKeyGet(integrationKey, acceptLanguage, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundRequestsApi.inboundRequestsIntegrationKeyGet: " + 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\ApiInboundRequestsApi();
$integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity. The format of the integration key for the InboundRequest entity is  'InboundRequest_creationtime|InboundRequest_messageId|InboundRequest_requestIntegrationKey'.
$acceptLanguage = acceptLanguage_example; // String | Header to specify the language localized data will be returned in.
$$expand = $expand_example; // String | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html).

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

my $api_instance = WWW::SwaggerClient::InboundRequestsApi->new();
my $integrationKey = integrationKey_example; # String | Unique identifier for an EDMX entity. The format of the integration key for the InboundRequest entity is  'InboundRequest_creationtime|InboundRequest_messageId|InboundRequest_requestIntegrationKey'.
my $acceptLanguage = acceptLanguage_example; # String | Header to specify the language localized data will be returned in.
my $$expand = $expand_example; # String | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html).

eval { 
    my $result = $api_instance->inboundRequestsIntegrationKeyGet(integrationKey => $integrationKey, acceptLanguage => $acceptLanguage, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboundRequestsApi->inboundRequestsIntegrationKeyGet: $@\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.InboundRequestsApi()
integrationKey = integrationKey_example # String | Unique identifier for an EDMX entity. The format of the integration key for the InboundRequest entity is  'InboundRequest_creationtime|InboundRequest_messageId|InboundRequest_requestIntegrationKey'.
acceptLanguage = acceptLanguage_example # String | Header to specify the language localized data will be returned in. (optional)
$expand = $expand_example # String | Navigation properties for the associated entries inlined in the response body. By default, these navigation properties  are represented as deferred links pointing to the item resource. For more information, see [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html). (optional)

try: 
    # Retrieves an inbound request.
    api_response = api_instance.inbound_requests_integration_key_get(integrationKey, acceptLanguage=acceptLanguage, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboundRequestsApi->inboundRequestsIntegrationKeyGet: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
Unique identifier for an EDMX entity. The format of the integration key for the InboundRequest entity is 'InboundRequest_creationtime|InboundRequest_messageId|InboundRequest_requestIntegrationKey'.
Required
Header parameters
Name Description
Accept-Language
String
Header to specify the language localized data will be returned in.
Query parameters
Name Description
$expand
String
Navigation properties for the associated entries inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. For more information, 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 due to an invalid integrationKey found in the url because one or more Integration Objects have been misconfigured.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

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


inboundRequestscountGet

Retrieves the number of inbound requests.

Retrieves the total number of inbound requests.


/InboundRequests/$count

Usage and SDK Samples

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

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

public class InboundRequestsApiExample {

    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");

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

public class InboundRequestsApiExample {

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

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

// Retrieves the number of inbound requests.
[apiInstance inboundRequestscountGetWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboundMonitoringApi = require('inbound_monitoring_api');
var defaultClient = InboundMonitoringApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

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

            var apiInstance = new InboundRequestsApi();

            try
            {
                // Retrieves the number of inbound requests.
                'String' result = apiInstance.inboundRequestscountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundRequestsApi.inboundRequestscountGet: " + 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\ApiInboundRequestsApi();

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

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

eval { 
    my $result = $api_instance->inboundRequestscountGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboundRequestsApi->inboundRequestscountGet: $@\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.InboundRequestsApi()

try: 
    # Retrieves the number of inbound requests.
    api_response = api_instance.inbound_requestscount_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboundRequestsApi->inboundRequestscountGet: %s\n" % e)

Parameters

Responses

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


Metadata

metadataGet

Retrieves the EDMX document for the inbound monitoring.

Retrieves the metadata for an inbound monitoring integration object. The metadata consists of an Entity Data Model XML (EDMX) schema 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/InboundIntegrationMonitoring/$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];

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

var api = new InboundMonitoringApi.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
            {
                // Retrieves the EDMX document for the inbound monitoring.
                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: 
    # Retrieves the EDMX document for the inbound monitoring.
    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