Integration Service API

InboundChannelConfigurations

inboundChannelConfigurationsGet

Retrieves the inbound channel configurations.

Retrieves the details of inbound channel configurations.


/InboundChannelConfigurations

Usage and SDK Samples

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

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

public class InboundChannelConfigurationsApiExample {

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

        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        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_2 result = apiInstance.inboundChannelConfigurationsGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InboundChannelConfigurationsApi;

public class InboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        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_2 result = apiInstance.inboundChannelConfigurationsGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsGet");
            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)

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

// Retrieves the inbound channel configurations.
[apiInstance inboundChannelConfigurationsGetWith:$top
    $skip:$skip
    $filter:$filter
    $inlinecount:$inlinecount
    $expand:$expand
              completionHandler: ^(Wrapper_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegrationServiceApi = require('integration_service_api');
var defaultClient = IntegrationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IntegrationServiceApi.InboundChannelConfigurationsApi()
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.inboundChannelConfigurationsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InboundChannelConfigurationsApi();
            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
            {
                // Retrieves the inbound channel configurations.
                Wrapper_2 result = apiInstance.inboundChannelConfigurationsGet($top, $skip, $filter, $inlinecount, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundChannelConfigurationsApi.inboundChannelConfigurationsGet: " + 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\ApiInboundChannelConfigurationsApi();
$$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->inboundChannelConfigurationsGet($$top, $$skip, $$filter, $$inlinecount, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InboundChannelConfigurationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::InboundChannelConfigurationsApi->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->inboundChannelConfigurationsGet($top => $$top, $skip => $$skip, $filter => $$filter, $inlinecount => $$inlinecount, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsGet: $@\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.InboundChannelConfigurationsApi()
$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: 
    # Retrieves the inbound channel configurations.
    api_response = api_instance.inbound_channel_configurations_get($top=$top, $skip=$skip, $filter=$filter, $inlinecount=$inlinecount, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsGet: %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 - A collection of 0 or more InboundChannelConfigurations.

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.


inboundChannelConfigurationsIntegrationKeyDelete

Deletes an inbound channel configuration.

Deletes an inbound channel configuration with the corresponding integration key.


/InboundChannelConfigurations(%27{integrationKey}%27)

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://localhost:9002/odata2webservices/IntegrationService/InboundChannelConfigurations(%27{integrationKey}%27)"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InboundChannelConfigurationsApi;

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

public class InboundChannelConfigurationsApiExample {

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

        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            apiInstance.inboundChannelConfigurationsIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsIntegrationKeyDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InboundChannelConfigurationsApi;

public class InboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            apiInstance.inboundChannelConfigurationsIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsIntegrationKeyDelete");
            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 *integrationMessageId = integrationMessageId_example; // Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

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

// Deletes an inbound channel configuration.
[apiInstance inboundChannelConfigurationsIntegrationKeyDeleteWith:integrationKey
    integrationMessageId:integrationMessageId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegrationServiceApi = require('integration_service_api');
var defaultClient = IntegrationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IntegrationServiceApi.InboundChannelConfigurationsApi()
var integrationKey = integrationKey_example; // {{String}} key: integrationKey
var opts = { 
  'integrationMessageId': integrationMessageId_example // {{String}} Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.inboundChannelConfigurationsIntegrationKeyDelete(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InboundChannelConfigurationsApi();
            var integrationKey = integrationKey_example;  // String | key: integrationKey
            var integrationMessageId = integrationMessageId_example;  // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional) 

            try
            {
                // Deletes an inbound channel configuration.
                apiInstance.inboundChannelConfigurationsIntegrationKeyDelete(integrationKey, integrationMessageId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundChannelConfigurationsApi.inboundChannelConfigurationsIntegrationKeyDelete: " + 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\ApiInboundChannelConfigurationsApi();
$integrationKey = integrationKey_example; // String | key: integrationKey
$integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

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

my $api_instance = WWW::SwaggerClient::InboundChannelConfigurationsApi->new();
my $integrationKey = integrationKey_example; # String | key: integrationKey
my $integrationMessageId = integrationMessageId_example; # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

eval { 
    $api_instance->inboundChannelConfigurationsIntegrationKeyDelete(integrationKey => $integrationKey, integrationMessageId => $integrationMessageId);
};
if ($@) {
    warn "Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsIntegrationKeyDelete: $@\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.InboundChannelConfigurationsApi()
integrationKey = integrationKey_example # String | key: integrationKey
integrationMessageId = integrationMessageId_example # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

try: 
    # Deletes an inbound channel configuration.
    api_instance.inbound_channel_configurations_integration_key_delete(integrationKey, integrationMessageId=integrationMessageId)
except ApiException as e:
    print("Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsIntegrationKeyDelete: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
key: integrationKey
Required
Header parameters
Name Description
integrationMessageId
String
Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

Responses

Status: 200 - Indicates that the InboundChannelConfiguration was successfully deleted.

Status: 400 - Error responses that may occur when a DELETE request is made in an attempt to delete an item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 404 - Not Found exception responses for PATCH and DELETE operations.


inboundChannelConfigurationsIntegrationKeyGet

Retrieves an inbound channel configuration.

Retrieves an inbound channel configuration by its integration key.


/InboundChannelConfigurations(%27{integrationKey}%27)

Usage and SDK Samples

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

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

public class InboundChannelConfigurationsApiExample {

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

        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        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 {
            Wrapper_3 result = apiInstance.inboundChannelConfigurationsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InboundChannelConfigurationsApi;

public class InboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        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 {
            Wrapper_3 result = apiInstance.inboundChannelConfigurationsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsIntegrationKeyGet");
            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)

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

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

var api = new IntegrationServiceApi.InboundChannelConfigurationsApi()
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.inboundChannelConfigurationsIntegrationKeyGet(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InboundChannelConfigurationsApi();
            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
            {
                // Retrieves an inbound channel configuration.
                Wrapper_3 result = apiInstance.inboundChannelConfigurationsIntegrationKeyGet(integrationKey, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundChannelConfigurationsApi.inboundChannelConfigurationsIntegrationKeyGet: " + 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\ApiInboundChannelConfigurationsApi();
$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->inboundChannelConfigurationsIntegrationKeyGet($integrationKey, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsIntegrationKeyGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InboundChannelConfigurationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::InboundChannelConfigurationsApi->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->inboundChannelConfigurationsIntegrationKeyGet(integrationKey => $integrationKey, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsIntegrationKeyGet: $@\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.InboundChannelConfigurationsApi()
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: 
    # Retrieves an inbound channel configuration.
    api_response = api_instance.inbound_channel_configurations_integration_key_get(integrationKey, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsIntegrationKeyGet: %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 - Success response with the retrieved InboundChannelConfiguration.

Status: 400 - An error occurred due to an invalid integrationKey found in the url or because the schema cannot be generated 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.


inboundChannelConfigurationsIntegrationKeyPatch

Updates an inbound channel configuration.

Updates an inbound channel configuration with the corresponding integration key. For more information about the PATCH behavior, see [The Integration Patch API](https://help.sap.com/viewer/50c996852b32456c96d3161a95544cdb/latest/en-US/25aa5bc96b3e4ceb958a4aee039db7c1.html).


/InboundChannelConfigurations(%27{integrationKey}%27)

Usage and SDK Samples

curl -X PATCH\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://localhost:9002/odata2webservices/IntegrationService/InboundChannelConfigurations(%27{integrationKey}%27)"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InboundChannelConfigurationsApi;

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

public class InboundChannelConfigurationsApiExample {

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

        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        InboundChannelConfiguration body = ; // InboundChannelConfiguration | 
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            Wrapper_3 result = apiInstance.inboundChannelConfigurationsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsIntegrationKeyPatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InboundChannelConfigurationsApi;

public class InboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        InboundChannelConfiguration body = ; // InboundChannelConfiguration | 
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            Wrapper_3 result = apiInstance.inboundChannelConfigurationsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsIntegrationKeyPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
InboundChannelConfiguration *body = ; // 
String *integrationKey = integrationKey_example; // key: integrationKey
String *prePersistHook = prePersistHook_example; // Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
String *postPersistHook = postPersistHook_example; // Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
String *integrationMessageId = integrationMessageId_example; // Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

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

// Updates an inbound channel configuration.
[apiInstance inboundChannelConfigurationsIntegrationKeyPatchWith:body
    integrationKey:integrationKey
    prePersistHook:prePersistHook
    postPersistHook:postPersistHook
    integrationMessageId:integrationMessageId
              completionHandler: ^(Wrapper_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegrationServiceApi = require('integration_service_api');
var defaultClient = IntegrationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IntegrationServiceApi.InboundChannelConfigurationsApi()
var body = ; // {{InboundChannelConfiguration}} 
var integrationKey = integrationKey_example; // {{String}} key: integrationKey
var opts = { 
  'prePersistHook': prePersistHook_example // {{String}} Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'postPersistHook': postPersistHook_example // {{String}} Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'integrationMessageId': integrationMessageId_example // {{String}} Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.inboundChannelConfigurationsIntegrationKeyPatch(bodyintegrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InboundChannelConfigurationsApi();
            var body = new InboundChannelConfiguration(); // InboundChannelConfiguration | 
            var integrationKey = integrationKey_example;  // String | key: integrationKey
            var prePersistHook = prePersistHook_example;  // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional) 
            var postPersistHook = postPersistHook_example;  // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional) 
            var integrationMessageId = integrationMessageId_example;  // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional) 

            try
            {
                // Updates an inbound channel configuration.
                Wrapper_3 result = apiInstance.inboundChannelConfigurationsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundChannelConfigurationsApi.inboundChannelConfigurationsIntegrationKeyPatch: " + 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\ApiInboundChannelConfigurationsApi();
$body = ; // InboundChannelConfiguration | 
$integrationKey = integrationKey_example; // String | key: integrationKey
$prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

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

my $api_instance = WWW::SwaggerClient::InboundChannelConfigurationsApi->new();
my $body = WWW::SwaggerClient::Object::InboundChannelConfiguration->new(); # InboundChannelConfiguration | 
my $integrationKey = integrationKey_example; # String | key: integrationKey
my $prePersistHook = prePersistHook_example; # String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
my $postPersistHook = postPersistHook_example; # String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
my $integrationMessageId = integrationMessageId_example; # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

eval { 
    my $result = $api_instance->inboundChannelConfigurationsIntegrationKeyPatch(body => $body, integrationKey => $integrationKey, prePersistHook => $prePersistHook, postPersistHook => $postPersistHook, integrationMessageId => $integrationMessageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsIntegrationKeyPatch: $@\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.InboundChannelConfigurationsApi()
body =  # InboundChannelConfiguration | 
integrationKey = integrationKey_example # String | key: integrationKey
prePersistHook = prePersistHook_example # String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
postPersistHook = postPersistHook_example # String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
integrationMessageId = integrationMessageId_example # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

try: 
    # Updates an inbound channel configuration.
    api_response = api_instance.inbound_channel_configurations_integration_key_patch(body, integrationKey, prePersistHook=prePersistHook, postPersistHook=postPersistHook, integrationMessageId=integrationMessageId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsIntegrationKeyPatch: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
key: integrationKey
Required
Header parameters
Name Description
Pre-Persist-Hook
String
Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
Post-Persist-Hook
String
Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
integrationMessageId
String
Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
Body parameters
Name Description
body *

Responses

Status: 200 - Indicates the Inbound Channel Configuration has been successfully updated.

Status: 400 - Error responses that may occur due to misconfigured metadata or an error occurring during an attempt to update an existing Item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 404 - Not Found exception responses for PATCH and DELETE operations.

Status: 415 - Provided Media-Type is not supported


inboundChannelConfigurationsPost

Creates an inbound channel configuration.

Creates an inbound channel configuration or updates an existing one in the system. For more information about the POST behavior, see [Integration Post API](https://help.sap.com/viewer/50c996852b32456c96d3161a95544cdb/latest/en-US/f6fadc372ac4445c93dcc29fdaf9917c.html).


/InboundChannelConfigurations

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://localhost:9002/odata2webservices/IntegrationService/InboundChannelConfigurations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InboundChannelConfigurationsApi;

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

public class InboundChannelConfigurationsApiExample {

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

        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        InboundChannelConfigurations_body body = ; // InboundChannelConfigurations_body | 
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            Wrapper_3 result = apiInstance.inboundChannelConfigurationsPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InboundChannelConfigurationsApi;

public class InboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        InboundChannelConfigurationsApi apiInstance = new InboundChannelConfigurationsApi();
        InboundChannelConfigurations_body body = ; // InboundChannelConfigurations_body | 
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            Wrapper_3 result = apiInstance.inboundChannelConfigurationsPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboundChannelConfigurationsApi#inboundChannelConfigurationsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
InboundChannelConfigurations_body *body = ; // 
String *prePersistHook = prePersistHook_example; // Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
String *postPersistHook = postPersistHook_example; // Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
String *integrationMessageId = integrationMessageId_example; // Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

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

// Creates an inbound channel configuration.
[apiInstance inboundChannelConfigurationsPostWith:body
    prePersistHook:prePersistHook
    postPersistHook:postPersistHook
    integrationMessageId:integrationMessageId
              completionHandler: ^(Wrapper_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegrationServiceApi = require('integration_service_api');
var defaultClient = IntegrationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IntegrationServiceApi.InboundChannelConfigurationsApi()
var body = ; // {{InboundChannelConfigurations_body}} 
var opts = { 
  'prePersistHook': prePersistHook_example // {{String}} Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'postPersistHook': postPersistHook_example // {{String}} Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'integrationMessageId': integrationMessageId_example // {{String}} Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.inboundChannelConfigurationsPost(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InboundChannelConfigurationsApi();
            var body = new InboundChannelConfigurations_body(); // InboundChannelConfigurations_body | 
            var prePersistHook = prePersistHook_example;  // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional) 
            var postPersistHook = postPersistHook_example;  // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional) 
            var integrationMessageId = integrationMessageId_example;  // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional) 

            try
            {
                // Creates an inbound channel configuration.
                Wrapper_3 result = apiInstance.inboundChannelConfigurationsPost(body, prePersistHook, postPersistHook, integrationMessageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundChannelConfigurationsApi.inboundChannelConfigurationsPost: " + 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\ApiInboundChannelConfigurationsApi();
$body = ; // InboundChannelConfigurations_body | 
$prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

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

my $api_instance = WWW::SwaggerClient::InboundChannelConfigurationsApi->new();
my $body = WWW::SwaggerClient::Object::InboundChannelConfigurations_body->new(); # InboundChannelConfigurations_body | 
my $prePersistHook = prePersistHook_example; # String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
my $postPersistHook = postPersistHook_example; # String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
my $integrationMessageId = integrationMessageId_example; # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

eval { 
    my $result = $api_instance->inboundChannelConfigurationsPost(body => $body, prePersistHook => $prePersistHook, postPersistHook => $postPersistHook, integrationMessageId => $integrationMessageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsPost: $@\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.InboundChannelConfigurationsApi()
body =  # InboundChannelConfigurations_body | 
prePersistHook = prePersistHook_example # String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
postPersistHook = postPersistHook_example # String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
integrationMessageId = integrationMessageId_example # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

try: 
    # Creates an inbound channel configuration.
    api_response = api_instance.inbound_channel_configurations_post(body, prePersistHook=prePersistHook, postPersistHook=postPersistHook, integrationMessageId=integrationMessageId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationsPost: %s\n" % e)

Parameters

Header parameters
Name Description
Pre-Persist-Hook
String
Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
Post-Persist-Hook
String
Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
integrationMessageId
String
Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
Body parameters
Name Description
body *

Responses

Status: 201 - Indicates the Inbound Channel Configuration has been successfully created/updated.

Status: 400 - Error responses that may occur due to misconfigured metadata or an error occurring during an attempt to create a new Item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

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

Status: 415 - Provided Media-Type is not supported


inboundChannelConfigurationscountGet

Retrieves the number of inbound channel configurations.

Retrieves the total number of inbound channel configurations.


/InboundChannelConfigurations/$count

Usage and SDK Samples

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

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

public class InboundChannelConfigurationsApiExample {

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

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

public class InboundChannelConfigurationsApiExample {

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

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

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

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

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

            var apiInstance = new InboundChannelConfigurationsApi();

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

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

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

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

try: 
    # Retrieves the number of inbound channel configurations.
    api_response = api_instance.inbound_channel_configurationscount_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboundChannelConfigurationsApi->inboundChannelConfigurationscountGet: %s\n" % e)

Parameters

Responses

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


IntegrationObjects

integrationObjectsGet

Retrieves integration objects exposed by the Integration API.

Retrieves all integration objects defined in the Integration API. Some of these objects may be exposed for inbound REST requests from external systems if they are associated with an InboundChannelConfiguration. Some of them may be used to format payloads of objects sent to an external system if they are associated with an OutboundChannelConfiguration or a WebhookConfiguration, and some may not be used.


/IntegrationObjects

Usage and SDK Samples

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

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

public class IntegrationObjectsApiExample {

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

        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        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.integrationObjectsGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IntegrationObjectsApi;

public class IntegrationObjectsApiExample {

    public static void main(String[] args) {
        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        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.integrationObjectsGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsGet");
            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)

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

// Retrieves integration objects exposed by the Integration API.
[apiInstance integrationObjectsGetWith:$top
    $skip:$skip
    $filter:$filter
    $inlinecount:$inlinecount
    $expand:$expand
              completionHandler: ^(Wrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegrationServiceApi = require('integration_service_api');
var defaultClient = IntegrationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IntegrationServiceApi.IntegrationObjectsApi()
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.integrationObjectsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new IntegrationObjectsApi();
            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
            {
                // Retrieves integration objects exposed by the Integration API.
                Wrapper result = apiInstance.integrationObjectsGet($top, $skip, $filter, $inlinecount, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationObjectsApi.integrationObjectsGet: " + 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\ApiIntegrationObjectsApi();
$$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->integrationObjectsGet($$top, $$skip, $$filter, $$inlinecount, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationObjectsApi->integrationObjectsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IntegrationObjectsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::IntegrationObjectsApi->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->integrationObjectsGet($top => $$top, $skip => $$skip, $filter => $$filter, $inlinecount => $$inlinecount, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IntegrationObjectsApi->integrationObjectsGet: $@\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.IntegrationObjectsApi()
$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: 
    # Retrieves integration objects exposed by the Integration API.
    api_response = api_instance.integration_objects_get($top=$top, $skip=$skip, $filter=$filter, $inlinecount=$inlinecount, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationObjectsApi->integrationObjectsGet: %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 - A collection of 0 or more IntegrationObjects.

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.


integrationObjectsIntegrationKeyDelete

Deletes an Integration Object.

Deletes an Integration Object with the corresponding integration key.


/IntegrationObjects(%27{integrationKey}%27)

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://localhost:9002/odata2webservices/IntegrationService/IntegrationObjects(%27{integrationKey}%27)"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IntegrationObjectsApi;

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

public class IntegrationObjectsApiExample {

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

        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            apiInstance.integrationObjectsIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsIntegrationKeyDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IntegrationObjectsApi;

public class IntegrationObjectsApiExample {

    public static void main(String[] args) {
        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            apiInstance.integrationObjectsIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsIntegrationKeyDelete");
            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 *integrationMessageId = integrationMessageId_example; // Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

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

// Deletes an Integration Object.
[apiInstance integrationObjectsIntegrationKeyDeleteWith:integrationKey
    integrationMessageId:integrationMessageId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegrationServiceApi = require('integration_service_api');
var defaultClient = IntegrationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IntegrationServiceApi.IntegrationObjectsApi()
var integrationKey = integrationKey_example; // {{String}} key: integrationKey
var opts = { 
  'integrationMessageId': integrationMessageId_example // {{String}} Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.integrationObjectsIntegrationKeyDelete(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new IntegrationObjectsApi();
            var integrationKey = integrationKey_example;  // String | key: integrationKey
            var integrationMessageId = integrationMessageId_example;  // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional) 

            try
            {
                // Deletes an Integration Object.
                apiInstance.integrationObjectsIntegrationKeyDelete(integrationKey, integrationMessageId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationObjectsApi.integrationObjectsIntegrationKeyDelete: " + 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\ApiIntegrationObjectsApi();
$integrationKey = integrationKey_example; // String | key: integrationKey
$integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

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

my $api_instance = WWW::SwaggerClient::IntegrationObjectsApi->new();
my $integrationKey = integrationKey_example; # String | key: integrationKey
my $integrationMessageId = integrationMessageId_example; # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

eval { 
    $api_instance->integrationObjectsIntegrationKeyDelete(integrationKey => $integrationKey, integrationMessageId => $integrationMessageId);
};
if ($@) {
    warn "Exception when calling IntegrationObjectsApi->integrationObjectsIntegrationKeyDelete: $@\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.IntegrationObjectsApi()
integrationKey = integrationKey_example # String | key: integrationKey
integrationMessageId = integrationMessageId_example # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

try: 
    # Deletes an Integration Object.
    api_instance.integration_objects_integration_key_delete(integrationKey, integrationMessageId=integrationMessageId)
except ApiException as e:
    print("Exception when calling IntegrationObjectsApi->integrationObjectsIntegrationKeyDelete: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
key: integrationKey
Required
Header parameters
Name Description
integrationMessageId
String
Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

Responses

Status: 200 - Indicates that the IntegrationObject was successfully deleted.

Status: 400 - Error responses that may occur when a DELETE request is made in an attempt to delete an item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 404 - Not Found exception responses for PATCH and DELETE operations.


integrationObjectsIntegrationKeyGet

Retrieves an Integration Object.

Retrieves an Integration Object by its integration key.


/IntegrationObjects(%27{integrationKey}%27)

Usage and SDK Samples

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

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

public class IntegrationObjectsApiExample {

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

        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        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 {
            Wrapper_1 result = apiInstance.integrationObjectsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IntegrationObjectsApi;

public class IntegrationObjectsApiExample {

    public static void main(String[] args) {
        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        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 {
            Wrapper_1 result = apiInstance.integrationObjectsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsIntegrationKeyGet");
            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)

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

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

var api = new IntegrationServiceApi.IntegrationObjectsApi()
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.integrationObjectsIntegrationKeyGet(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new IntegrationObjectsApi();
            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
            {
                // Retrieves an Integration Object.
                Wrapper_1 result = apiInstance.integrationObjectsIntegrationKeyGet(integrationKey, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationObjectsApi.integrationObjectsIntegrationKeyGet: " + 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\ApiIntegrationObjectsApi();
$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->integrationObjectsIntegrationKeyGet($integrationKey, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationObjectsApi->integrationObjectsIntegrationKeyGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IntegrationObjectsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::IntegrationObjectsApi->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->integrationObjectsIntegrationKeyGet(integrationKey => $integrationKey, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IntegrationObjectsApi->integrationObjectsIntegrationKeyGet: $@\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.IntegrationObjectsApi()
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: 
    # Retrieves an Integration Object.
    api_response = api_instance.integration_objects_integration_key_get(integrationKey, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationObjectsApi->integrationObjectsIntegrationKeyGet: %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 - Success response with the retrieved IntegrationObject.

Status: 400 - An error occurred due to an invalid integrationKey found in the url or because the schema cannot be generated 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.


integrationObjectsIntegrationKeyPatch

Updates an Integration Object.

Updates an Integration Object with the corresponding integration key. For more information about the PATCH behavior, see [The Integration Patch API](https://help.sap.com/viewer/50c996852b32456c96d3161a95544cdb/latest/en-US/25aa5bc96b3e4ceb958a4aee039db7c1.html).


/IntegrationObjects(%27{integrationKey}%27)

Usage and SDK Samples

curl -X PATCH\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://localhost:9002/odata2webservices/IntegrationService/IntegrationObjects(%27{integrationKey}%27)"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IntegrationObjectsApi;

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

public class IntegrationObjectsApiExample {

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

        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        IntegrationObject body = ; // IntegrationObject | 
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            Wrapper_1 result = apiInstance.integrationObjectsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsIntegrationKeyPatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IntegrationObjectsApi;

public class IntegrationObjectsApiExample {

    public static void main(String[] args) {
        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        IntegrationObject body = ; // IntegrationObject | 
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            Wrapper_1 result = apiInstance.integrationObjectsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsIntegrationKeyPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
IntegrationObject *body = ; // 
String *integrationKey = integrationKey_example; // key: integrationKey
String *prePersistHook = prePersistHook_example; // Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
String *postPersistHook = postPersistHook_example; // Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
String *integrationMessageId = integrationMessageId_example; // Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

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

// Updates an Integration Object.
[apiInstance integrationObjectsIntegrationKeyPatchWith:body
    integrationKey:integrationKey
    prePersistHook:prePersistHook
    postPersistHook:postPersistHook
    integrationMessageId:integrationMessageId
              completionHandler: ^(Wrapper_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegrationServiceApi = require('integration_service_api');
var defaultClient = IntegrationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IntegrationServiceApi.IntegrationObjectsApi()
var body = ; // {{IntegrationObject}} 
var integrationKey = integrationKey_example; // {{String}} key: integrationKey
var opts = { 
  'prePersistHook': prePersistHook_example // {{String}} Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'postPersistHook': postPersistHook_example // {{String}} Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'integrationMessageId': integrationMessageId_example // {{String}} Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.integrationObjectsIntegrationKeyPatch(bodyintegrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new IntegrationObjectsApi();
            var body = new IntegrationObject(); // IntegrationObject | 
            var integrationKey = integrationKey_example;  // String | key: integrationKey
            var prePersistHook = prePersistHook_example;  // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional) 
            var postPersistHook = postPersistHook_example;  // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional) 
            var integrationMessageId = integrationMessageId_example;  // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional) 

            try
            {
                // Updates an Integration Object.
                Wrapper_1 result = apiInstance.integrationObjectsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationObjectsApi.integrationObjectsIntegrationKeyPatch: " + 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\ApiIntegrationObjectsApi();
$body = ; // IntegrationObject | 
$integrationKey = integrationKey_example; // String | key: integrationKey
$prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

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

my $api_instance = WWW::SwaggerClient::IntegrationObjectsApi->new();
my $body = WWW::SwaggerClient::Object::IntegrationObject->new(); # IntegrationObject | 
my $integrationKey = integrationKey_example; # String | key: integrationKey
my $prePersistHook = prePersistHook_example; # String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
my $postPersistHook = postPersistHook_example; # String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
my $integrationMessageId = integrationMessageId_example; # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

eval { 
    my $result = $api_instance->integrationObjectsIntegrationKeyPatch(body => $body, integrationKey => $integrationKey, prePersistHook => $prePersistHook, postPersistHook => $postPersistHook, integrationMessageId => $integrationMessageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IntegrationObjectsApi->integrationObjectsIntegrationKeyPatch: $@\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.IntegrationObjectsApi()
body =  # IntegrationObject | 
integrationKey = integrationKey_example # String | key: integrationKey
prePersistHook = prePersistHook_example # String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
postPersistHook = postPersistHook_example # String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
integrationMessageId = integrationMessageId_example # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

try: 
    # Updates an Integration Object.
    api_response = api_instance.integration_objects_integration_key_patch(body, integrationKey, prePersistHook=prePersistHook, postPersistHook=postPersistHook, integrationMessageId=integrationMessageId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationObjectsApi->integrationObjectsIntegrationKeyPatch: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
key: integrationKey
Required
Header parameters
Name Description
Pre-Persist-Hook
String
Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
Post-Persist-Hook
String
Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
integrationMessageId
String
Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
Body parameters
Name Description
body *

Responses

Status: 200 - Indicates the Integration Object has been successfully updated.

Status: 400 - Error responses that may occur due to misconfigured metadata or an error occurring during an attempt to update an existing Item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 404 - Not Found exception responses for PATCH and DELETE operations.

Status: 415 - Provided Media-Type is not supported


integrationObjectsPost

Creates an Integration Object.

Creates an Integration Object or updates an existing one in the system. For more information about the POST behavior, see [The Integration Post API](https://help.sap.com/viewer/50c996852b32456c96d3161a95544cdb/latest/en-US/f6fadc372ac4445c93dcc29fdaf9917c.html).


/IntegrationObjects

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://localhost:9002/odata2webservices/IntegrationService/IntegrationObjects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IntegrationObjectsApi;

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

public class IntegrationObjectsApiExample {

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

        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        IntegrationObjects_body body = ; // IntegrationObjects_body | 
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            Wrapper_1 result = apiInstance.integrationObjectsPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IntegrationObjectsApi;

public class IntegrationObjectsApiExample {

    public static void main(String[] args) {
        IntegrationObjectsApi apiInstance = new IntegrationObjectsApi();
        IntegrationObjects_body body = ; // IntegrationObjects_body | 
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
        String integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
        try {
            Wrapper_1 result = apiInstance.integrationObjectsPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationObjectsApi#integrationObjectsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
IntegrationObjects_body *body = ; // 
String *prePersistHook = prePersistHook_example; // Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
String *postPersistHook = postPersistHook_example; // Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
String *integrationMessageId = integrationMessageId_example; // Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

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

// Creates an Integration Object.
[apiInstance integrationObjectsPostWith:body
    prePersistHook:prePersistHook
    postPersistHook:postPersistHook
    integrationMessageId:integrationMessageId
              completionHandler: ^(Wrapper_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegrationServiceApi = require('integration_service_api');
var defaultClient = IntegrationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IntegrationServiceApi.IntegrationObjectsApi()
var body = ; // {{IntegrationObjects_body}} 
var opts = { 
  'prePersistHook': prePersistHook_example // {{String}} Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'postPersistHook': postPersistHook_example // {{String}} Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'integrationMessageId': integrationMessageId_example // {{String}} Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.integrationObjectsPost(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new IntegrationObjectsApi();
            var body = new IntegrationObjects_body(); // IntegrationObjects_body | 
            var prePersistHook = prePersistHook_example;  // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional) 
            var postPersistHook = postPersistHook_example;  // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional) 
            var integrationMessageId = integrationMessageId_example;  // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional) 

            try
            {
                // Creates an Integration Object.
                Wrapper_1 result = apiInstance.integrationObjectsPost(body, prePersistHook, postPersistHook, integrationMessageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationObjectsApi.integrationObjectsPost: " + 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\ApiIntegrationObjectsApi();
$body = ; // IntegrationObjects_body | 
$prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$postPersistHook = postPersistHook_example; // String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$integrationMessageId = integrationMessageId_example; // String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

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

my $api_instance = WWW::SwaggerClient::IntegrationObjectsApi->new();
my $body = WWW::SwaggerClient::Object::IntegrationObjects_body->new(); # IntegrationObjects_body | 
my $prePersistHook = prePersistHook_example; # String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
my $postPersistHook = postPersistHook_example; # String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
my $integrationMessageId = integrationMessageId_example; # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request.

eval { 
    my $result = $api_instance->integrationObjectsPost(body => $body, prePersistHook => $prePersistHook, postPersistHook => $postPersistHook, integrationMessageId => $integrationMessageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IntegrationObjectsApi->integrationObjectsPost: $@\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.IntegrationObjectsApi()
body =  # IntegrationObjects_body | 
prePersistHook = prePersistHook_example # String | Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted  in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
postPersistHook = postPersistHook_example # String | Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform.  For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html). (optional)
integrationMessageId = integrationMessageId_example # String | Header to trace any inbound request back to its original POST, PATCH, or DELETE request. (optional)

try: 
    # Creates an Integration Object.
    api_response = api_instance.integration_objects_post(body, prePersistHook=prePersistHook, postPersistHook=postPersistHook, integrationMessageId=integrationMessageId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationObjectsApi->integrationObjectsPost: %s\n" % e)

Parameters

Header parameters
Name Description
Pre-Persist-Hook
String
Name of the pre-persist-hook that invokes before the Integration Object sent in the POST or PATCH request is persisted in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
Post-Persist-Hook
String
Name of the post-persist-hook that invokes after the Integration Object is persisted in the SAP Commerce platform. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
integrationMessageId
String
Header to trace any inbound request back to its original POST, PATCH, or DELETE request.
Body parameters
Name Description
body *

Responses

Status: 201 - Indicates the Integration Object has been successfully created/updated.

Status: 400 - Error responses that may occur due to misconfigured metadata or an error occurring during an attempt to create a new Item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

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

Status: 415 - Provided Media-Type is not supported


integrationObjectscountGet

Retrieves the number of Integration Objects.

Retrieves the total number of Integration Objects.


/IntegrationObjects/$count

Usage and SDK Samples

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

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

public class IntegrationObjectsApiExample {

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

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

public class IntegrationObjectsApiExample {

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

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

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

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

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

            var apiInstance = new IntegrationObjectsApi();

            try
            {
                // Retrieves the number of Integration Objects.
                'String' result = apiInstance.integrationObjectscountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationObjectsApi.integrationObjectscountGet: " + 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\ApiIntegrationObjectsApi();

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

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

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

try: 
    # Retrieves the number of Integration Objects.
    api_response = api_instance.integration_objectscount_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationObjectsApi->integrationObjectscountGet: %s\n" % e)

Parameters

Responses

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


Metadata

metadataGet

Retrieves the EDMX document for the integration service.

Retrieves the metadata for the integration service that describes the integration object exposed by the integration service API and its properties. 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/IntegrationService/$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 integration service.
[apiInstance metadataGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IntegrationServiceApi = require('integration_service_api');
var defaultClient = IntegrationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IntegrationServiceApi.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 integration service.
                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 integration service.
    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: 400 - The schema cannot be generated 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 POST operations.