Outbound Channel Configuration

Metadata

metadataGet

Retrieves the EDMX document for the OutboundChannelConfig Integration Object.

Retrieves the metadata for an outbound channel configuration Integration Object. The metadata consists of an Entity Data Model XML (EDMX) schema that describes the entity types and their properties.


/$metadata

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/xml"\
"https://localhost:9002/odata2webservices/OutboundChannelConfig/$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: basicAuthentication
        HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuthentication");
        basicAuthentication.setUsername("YOUR USERNAME");
        basicAuthentication.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: basicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

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

var api = new OutboundChannelConfiguration.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: basicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MetadataApi();

            try
            {
                // Retrieves the EDMX document for the OutboundChannelConfig Integration Object.
                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: basicAuthentication
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: basicAuthentication
$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: basicAuthentication
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 OutboundChannelConfig Integration Object.
    api_instance.metadata_get()
except ApiException as e:
    print("Exception when calling MetadataApi->metadataGet: %s\n" % e)

Parameters

Responses

Status: 200 - An EDMX for the requested service

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses


OutboundChannelConfigurations

outboundChannelConfigurationsGet

Retrieves the outbound channel configurations.

Retrieves all outbound channel configurations. Users can specify paging with `$skip` and `$top`, `$expand` deferred properties, and `$filter` results. For more information about retrievals, see [Retrieving Outbound Sync Configurations](https://help.sap.com/viewer/50c996852b32456c96d3161a95544cdb/latest/en-US/f3c109a69c2a4744874ec7f39db5af7e.html)


/OutboundChannelConfigurations

Usage and SDK Samples

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

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

public class OutboundChannelConfigurationsApiExample {

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

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

public class OutboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        OutboundChannelConfigurationsApi apiInstance = new OutboundChannelConfigurationsApi();
        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.outboundChannelConfigurationsGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundChannelConfigurationsApi#outboundChannelConfigurationsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuthentication)
[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)

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

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

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

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

            var apiInstance = new OutboundChannelConfigurationsApi();
            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 outbound channel configurations.
                Wrapper result = apiInstance.outboundChannelConfigurationsGet($top, $skip, $filter, $inlinecount, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutboundChannelConfigurationsApi.outboundChannelConfigurationsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiOutboundChannelConfigurationsApi();
$$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->outboundChannelConfigurationsGet($$top, $$skip, $$filter, $$inlinecount, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OutboundChannelConfigurationsApi;
# Configure HTTP basic authorization: basicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::OutboundChannelConfigurationsApi->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->outboundChannelConfigurationsGet($top => $$top, $skip => $$skip, $filter => $$filter, $inlinecount => $$inlinecount, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsGet: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OutboundChannelConfigurationsApi()
$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 outbound channel configurations.
    api_response = api_instance.outbound_channel_configurations_get($top=$top, $skip=$skip, $filter=$filter, $inlinecount=$inlinecount, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsGet: %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 OutboundChannelConfigurations

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

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

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


outboundChannelConfigurationsIntegrationKeyDelete

Deletes an outbound channel configuration.

Deletes a configuration according to the provided integration key. For more information about deletions, see [Deleting Outbound Sync Configurations](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/74012329adb14b29bcdf38b8ff4cb3a3.html).


/OutboundChannelConfigurations(%27{integrationKey}%27)

Usage and SDK Samples

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

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

public class OutboundChannelConfigurationsApiExample {

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

        OutboundChannelConfigurationsApi apiInstance = new OutboundChannelConfigurationsApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        String integrationMessageId = integrationMessageId_example; // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            apiInstance.outboundChannelConfigurationsIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundChannelConfigurationsApi#outboundChannelConfigurationsIntegrationKeyDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OutboundChannelConfigurationsApi;

public class OutboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        OutboundChannelConfigurationsApi apiInstance = new OutboundChannelConfigurationsApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        String integrationMessageId = integrationMessageId_example; // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            apiInstance.outboundChannelConfigurationsIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundChannelConfigurationsApi#outboundChannelConfigurationsIntegrationKeyDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *integrationKey = integrationKey_example; // Unique identifier for an EDMX entity.
String *integrationMessageId = integrationMessageId_example; // Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

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

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

var api = new OutboundChannelConfiguration.OutboundChannelConfigurationsApi()
var integrationKey = integrationKey_example; // {{String}} Unique identifier for an EDMX entity.
var opts = { 
  'integrationMessageId': integrationMessageId_example // {{String}} Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.outboundChannelConfigurationsIntegrationKeyDelete(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new OutboundChannelConfigurationsApi();
            var integrationKey = integrationKey_example;  // String | Unique identifier for an EDMX entity.
            var integrationMessageId = integrationMessageId_example;  // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional) 

            try
            {
                // Deletes an outbound channel configuration.
                apiInstance.outboundChannelConfigurationsIntegrationKeyDelete(integrationKey, integrationMessageId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutboundChannelConfigurationsApi.outboundChannelConfigurationsIntegrationKeyDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiOutboundChannelConfigurationsApi();
$integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
$integrationMessageId = integrationMessageId_example; // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

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

my $api_instance = WWW::SwaggerClient::OutboundChannelConfigurationsApi->new();
my $integrationKey = integrationKey_example; # String | Unique identifier for an EDMX entity.
my $integrationMessageId = integrationMessageId_example; # String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

eval { 
    $api_instance->outboundChannelConfigurationsIntegrationKeyDelete(integrationKey => $integrationKey, integrationMessageId => $integrationMessageId);
};
if ($@) {
    warn "Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsIntegrationKeyDelete: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OutboundChannelConfigurationsApi()
integrationKey = integrationKey_example # String | Unique identifier for an EDMX entity.
integrationMessageId = integrationMessageId_example # String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

try: 
    # Deletes an outbound channel configuration.
    api_instance.outbound_channel_configurations_integration_key_delete(integrationKey, integrationMessageId=integrationMessageId)
except ApiException as e:
    print("Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsIntegrationKeyDelete: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
Unique identifier for an EDMX entity.
Required
Header parameters
Name Description
integrationMessageId
String
Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request. For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

Responses

Status: 200 - Indicates the OutboundChannelConfiguration was deleted successfully

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.


outboundChannelConfigurationsIntegrationKeyGet

Retrieves an outbound channel configuration.

Retrieves one configuration according to the provided integration key. Users can expand deferred properties by specifying them as values to `$expand`.


/OutboundChannelConfigurations(%27{integrationKey}%27)

Usage and SDK Samples

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

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

public class OutboundChannelConfigurationsApiExample {

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

        OutboundChannelConfigurationsApi apiInstance = new OutboundChannelConfigurationsApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        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.outboundChannelConfigurationsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundChannelConfigurationsApi#outboundChannelConfigurationsIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OutboundChannelConfigurationsApi;

public class OutboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        OutboundChannelConfigurationsApi apiInstance = new OutboundChannelConfigurationsApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        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.outboundChannelConfigurationsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundChannelConfigurationsApi#outboundChannelConfigurationsIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *integrationKey = integrationKey_example; // Unique identifier for an EDMX entity.
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)

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

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

var api = new OutboundChannelConfiguration.OutboundChannelConfigurationsApi()
var integrationKey = integrationKey_example; // {{String}} Unique identifier for an EDMX entity.
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.outboundChannelConfigurationsIntegrationKeyGet(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new OutboundChannelConfigurationsApi();
            var integrationKey = integrationKey_example;  // String | Unique identifier for an EDMX entity.
            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 outbound channel configuration.
                Wrapper_1 result = apiInstance.outboundChannelConfigurationsIntegrationKeyGet(integrationKey, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutboundChannelConfigurationsApi.outboundChannelConfigurationsIntegrationKeyGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiOutboundChannelConfigurationsApi();
$integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
$$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->outboundChannelConfigurationsIntegrationKeyGet($integrationKey, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsIntegrationKeyGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OutboundChannelConfigurationsApi;
# Configure HTTP basic authorization: basicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::OutboundChannelConfigurationsApi->new();
my $integrationKey = integrationKey_example; # String | Unique identifier for an EDMX entity.
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->outboundChannelConfigurationsIntegrationKeyGet(integrationKey => $integrationKey, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsIntegrationKeyGet: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OutboundChannelConfigurationsApi()
integrationKey = integrationKey_example # String | Unique identifier for an EDMX entity.
$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 outbound channel configuration.
    api_response = api_instance.outbound_channel_configurations_integration_key_get(integrationKey, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsIntegrationKeyGet: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
Unique identifier for an EDMX entity.
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 a single OutboundChannelConfiguration

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 GET operations.


outboundChannelConfigurationsIntegrationKeyPatch

Updates an outbound channel configuration.

Updates an existing configuration according to the provided integration key. For more information about updates, see [Updating Outbound Sync Configurations](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/f54e7fd3374344c685c56aada1a2b496.html).


/OutboundChannelConfigurations(%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/OutboundChannelConfig/OutboundChannelConfigurations(%27{integrationKey}%27)"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OutboundChannelConfigurationsApi;

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

public class OutboundChannelConfigurationsApiExample {

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

        OutboundChannelConfigurationsApi apiInstance = new OutboundChannelConfigurationsApi();
        OutboundChannelConfiguration body = ; // OutboundChannelConfiguration | Note: The `code` of the outbound channel configuration cannot be modified because it's the integration key.  It can be included in the payload.
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            Wrapper_1 result = apiInstance.outboundChannelConfigurationsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundChannelConfigurationsApi#outboundChannelConfigurationsIntegrationKeyPatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OutboundChannelConfigurationsApi;

public class OutboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        OutboundChannelConfigurationsApi apiInstance = new OutboundChannelConfigurationsApi();
        OutboundChannelConfiguration body = ; // OutboundChannelConfiguration | Note: The `code` of the outbound channel configuration cannot be modified because it's the integration key.  It can be included in the payload.
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            Wrapper_1 result = apiInstance.outboundChannelConfigurationsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundChannelConfigurationsApi#outboundChannelConfigurationsIntegrationKeyPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
OutboundChannelConfiguration *body = ; // Note: The `code` of the outbound channel configuration cannot be modified because it's the integration key.  It can be included in the payload.
String *integrationKey = integrationKey_example; // Unique identifier for an EDMX entity.
String *prePersistHook = prePersistHook_example; // Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

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

// Updates an outbound channel configuration.
[apiInstance outboundChannelConfigurationsIntegrationKeyPatchWith: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 OutboundChannelConfiguration = require('outbound_channel_configuration');
var defaultClient = OutboundChannelConfiguration.ApiClient.instance;
// Configure HTTP basic authorization: basicAuthentication
var basicAuthentication = defaultClient.authentications['basicAuthentication'];
basicAuthentication.username = 'YOUR USERNAME'
basicAuthentication.password = 'YOUR PASSWORD'

var api = new OutboundChannelConfiguration.OutboundChannelConfigurationsApi()
var body = ; // {{OutboundChannelConfiguration}} Note: The `code` of the outbound channel configuration cannot be modified because it's the integration key.  It can be included in the payload.
var integrationKey = integrationKey_example; // {{String}} Unique identifier for an EDMX entity.
var opts = { 
  'prePersistHook': prePersistHook_example // {{String}} Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. For more details,  see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'integrationMessageId': integrationMessageId_example // {{String}} Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.outboundChannelConfigurationsIntegrationKeyPatch(bodyintegrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new OutboundChannelConfigurationsApi();
            var body = new OutboundChannelConfiguration(); // OutboundChannelConfiguration | Note: The `code` of the outbound channel configuration cannot be modified because it's the integration key.  It can be included in the payload.
            var integrationKey = integrationKey_example;  // String | Unique identifier for an EDMX entity.
            var prePersistHook = prePersistHook_example;  // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional) 

            try
            {
                // Updates an outbound channel configuration.
                Wrapper_1 result = apiInstance.outboundChannelConfigurationsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutboundChannelConfigurationsApi.outboundChannelConfigurationsIntegrationKeyPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiOutboundChannelConfigurationsApi();
$body = ; // OutboundChannelConfiguration | Note: The `code` of the outbound channel configuration cannot be modified because it's the integration key.  It can be included in the payload.
$integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
$prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. For more details,  see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$integrationMessageId = integrationMessageId_example; // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

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

my $api_instance = WWW::SwaggerClient::OutboundChannelConfigurationsApi->new();
my $body = WWW::SwaggerClient::Object::OutboundChannelConfiguration->new(); # OutboundChannelConfiguration | Note: The `code` of the outbound channel configuration cannot be modified because it's the integration key.  It can be included in the payload.
my $integrationKey = integrationKey_example; # String | Unique identifier for an EDMX entity.
my $prePersistHook = prePersistHook_example; # String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

eval { 
    my $result = $api_instance->outboundChannelConfigurationsIntegrationKeyPatch(body => $body, integrationKey => $integrationKey, prePersistHook => $prePersistHook, postPersistHook => $postPersistHook, integrationMessageId => $integrationMessageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsIntegrationKeyPatch: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OutboundChannelConfigurationsApi()
body =  # OutboundChannelConfiguration | Note: The `code` of the outbound channel configuration cannot be modified because it's the integration key.  It can be included in the payload.
integrationKey = integrationKey_example # String | Unique identifier for an EDMX entity.
prePersistHook = prePersistHook_example # String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

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

Parameters

Path parameters
Name Description
integrationKey*
String
Unique identifier for an EDMX entity.
Required
Header parameters
Name Description
Pre-Persist-Hook
String
Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
integrationMessageId
String
Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request. For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
Body parameters
Name Description
body *

Responses

Status: 200 - Success response with a single OutboundChannelConfiguration

Status: 400 - Error responses with a 400 status code that may occur when an attempt is made to PATCH 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


outboundChannelConfigurationsPost

Creates an outbound channel configuration.

Creates or updates an outbound channel configuration and all its related items, such as the cronjob, stream container, and stream, automatically by setting `autoCreate = true`. The consumed destination and endpoint can be pre-existing, or created along with the rest of the channel configuration. If creating the consumed destination with the request, the user should choose between using a basic or OAuth credential. For more information about post behavior, see [Creating Outbound Sync Configurations](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/be1ddcaea92445539a01127d67d3fc5e.html).


/OutboundChannelConfigurations

Usage and SDK Samples

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

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

public class OutboundChannelConfigurationsApiExample {

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

        OutboundChannelConfigurationsApi apiInstance = new OutboundChannelConfigurationsApi();
        OutboundChannelConfigurations_body body = ; // OutboundChannelConfigurations_body | 
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            Wrapper_1 result = apiInstance.outboundChannelConfigurationsPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundChannelConfigurationsApi#outboundChannelConfigurationsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OutboundChannelConfigurationsApi;

public class OutboundChannelConfigurationsApiExample {

    public static void main(String[] args) {
        OutboundChannelConfigurationsApi apiInstance = new OutboundChannelConfigurationsApi();
        OutboundChannelConfigurations_body body = ; // OutboundChannelConfigurations_body | 
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            Wrapper_1 result = apiInstance.outboundChannelConfigurationsPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutboundChannelConfigurationsApi#outboundChannelConfigurationsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
OutboundChannelConfigurations_body *body = ; // 
String *prePersistHook = prePersistHook_example; // Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

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

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

var api = new OutboundChannelConfiguration.OutboundChannelConfigurationsApi()
var body = ; // {{OutboundChannelConfigurations_body}} 
var opts = { 
  'prePersistHook': prePersistHook_example // {{String}} Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. For more details,  see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'integrationMessageId': integrationMessageId_example // {{String}} Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.outboundChannelConfigurationsPost(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new OutboundChannelConfigurationsApi();
            var body = new OutboundChannelConfigurations_body(); // OutboundChannelConfigurations_body | 
            var prePersistHook = prePersistHook_example;  // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional) 

            try
            {
                // Creates an outbound channel configuration.
                Wrapper_1 result = apiInstance.outboundChannelConfigurationsPost(body, prePersistHook, postPersistHook, integrationMessageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutboundChannelConfigurationsApi.outboundChannelConfigurationsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiOutboundChannelConfigurationsApi();
$body = ; // OutboundChannelConfigurations_body | 
$prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. For more details,  see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$integrationMessageId = integrationMessageId_example; // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

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

my $api_instance = WWW::SwaggerClient::OutboundChannelConfigurationsApi->new();
my $body = WWW::SwaggerClient::Object::OutboundChannelConfigurations_body->new(); # OutboundChannelConfigurations_body | 
my $prePersistHook = prePersistHook_example; # String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

eval { 
    my $result = $api_instance->outboundChannelConfigurationsPost(body => $body, prePersistHook => $prePersistHook, postPersistHook => $postPersistHook, integrationMessageId => $integrationMessageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationsPost: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OutboundChannelConfigurationsApi()
body =  # OutboundChannelConfigurations_body | 
prePersistHook = prePersistHook_example # String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

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

Parameters

Header parameters
Name Description
Pre-Persist-Hook
String
Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
integrationMessageId
String
Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request. For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
Body parameters
Name Description
body *

Responses

Status: 201 - Success response with a single OutboundChannelConfiguration

Status: 400 - Error responses that may occur when sending a POST request in an attempt to create a new Item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 415 - Provided Media-Type is not supported


outboundChannelConfigurationscountGet

Retrieves outbound channel configuration count.

Retrieves only the count of the configurations, and not the configurations themselves.


/OutboundChannelConfigurations/$count

Usage and SDK Samples

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

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

public class OutboundChannelConfigurationsApiExample {

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

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

public class OutboundChannelConfigurationsApiExample {

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

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

// Retrieves outbound channel configuration count.
[apiInstance outboundChannelConfigurationscountGetWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OutboundChannelConfiguration = require('outbound_channel_configuration');
var defaultClient = OutboundChannelConfiguration.ApiClient.instance;
// Configure HTTP basic authorization: basicAuthentication
var basicAuthentication = defaultClient.authentications['basicAuthentication'];
basicAuthentication.username = 'YOUR USERNAME'
basicAuthentication.password = 'YOUR PASSWORD'

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

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

            var apiInstance = new OutboundChannelConfigurationsApi();

            try
            {
                // Retrieves outbound channel configuration count.
                'String' result = apiInstance.outboundChannelConfigurationscountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutboundChannelConfigurationsApi.outboundChannelConfigurationscountGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

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

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

eval { 
    my $result = $api_instance->outboundChannelConfigurationscountGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationscountGet: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Retrieves outbound channel configuration count.
    api_response = api_instance.outbound_channel_configurationscount_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OutboundChannelConfigurationsApi->outboundChannelConfigurationscountGet: %s\n" % e)

Parameters

Responses

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


Triggers

triggercountGet

Retrieves the trigger count.

Retrieves only the trigger count, and not the triggers themselves.


/Trigger/$count

Usage and SDK Samples

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

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

public class TriggersApiExample {

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

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

public class TriggersApiExample {

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

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

// Retrieves the trigger count.
[apiInstance triggercountGetWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OutboundChannelConfiguration = require('outbound_channel_configuration');
var defaultClient = OutboundChannelConfiguration.ApiClient.instance;
// Configure HTTP basic authorization: basicAuthentication
var basicAuthentication = defaultClient.authentications['basicAuthentication'];
basicAuthentication.username = 'YOUR USERNAME'
basicAuthentication.password = 'YOUR PASSWORD'

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

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

            var apiInstance = new TriggersApi();

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

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

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

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

eval { 
    my $result = $api_instance->triggercountGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TriggersApi->triggercountGet: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Retrieves the trigger count.
    api_response = api_instance.triggercount_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TriggersApi->triggercountGet: %s\n" % e)

Parameters

Responses

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


triggersGet

Retrieves the triggers.

Retrieves all triggers. Users can specify paging with `$skip` and `$top`, `$expand` deferred properties, and `$filter` results.


/Triggers

Usage and SDK Samples

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

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

public class TriggersApiExample {

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

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

public class TriggersApiExample {

    public static void main(String[] args) {
        TriggersApi apiInstance = new TriggersApi();
        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.triggersGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#triggersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuthentication)
[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)

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

// Retrieves the triggers.
[apiInstance triggersGetWith:$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 OutboundChannelConfiguration = require('outbound_channel_configuration');
var defaultClient = OutboundChannelConfiguration.ApiClient.instance;
// Configure HTTP basic authorization: basicAuthentication
var basicAuthentication = defaultClient.authentications['basicAuthentication'];
basicAuthentication.username = 'YOUR USERNAME'
basicAuthentication.password = 'YOUR PASSWORD'

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

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

            var apiInstance = new TriggersApi();
            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 triggers.
                Wrapper_2 result = apiInstance.triggersGet($top, $skip, $filter, $inlinecount, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TriggersApi.triggersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiTriggersApi();
$$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->triggersGet($$top, $$skip, $$filter, $$inlinecount, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TriggersApi->triggersGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TriggersApi;
# Configure HTTP basic authorization: basicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::TriggersApi->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->triggersGet($top => $$top, $skip => $$skip, $filter => $$filter, $inlinecount => $$inlinecount, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TriggersApi->triggersGet: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.TriggersApi()
$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 triggers.
    api_response = api_instance.triggers_get($top=$top, $skip=$skip, $filter=$filter, $inlinecount=$inlinecount, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TriggersApi->triggersGet: %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 Triggers

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

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

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


triggersIntegrationKeyDelete

Deletes a trigger.

Delete a trigger according to the provided integration key.


/Triggers(%27integrationKey%27)

Usage and SDK Samples

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

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

public class TriggersApiExample {

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

        TriggersApi apiInstance = new TriggersApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        String integrationMessageId = integrationMessageId_example; // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            apiInstance.triggersIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#triggersIntegrationKeyDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TriggersApi;

public class TriggersApiExample {

    public static void main(String[] args) {
        TriggersApi apiInstance = new TriggersApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        String integrationMessageId = integrationMessageId_example; // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            apiInstance.triggersIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#triggersIntegrationKeyDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *integrationKey = integrationKey_example; // Unique identifier for an EDMX entity.
String *integrationMessageId = integrationMessageId_example; // Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

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

// Deletes a trigger.
[apiInstance triggersIntegrationKeyDeleteWith:integrationKey
    integrationMessageId:integrationMessageId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OutboundChannelConfiguration = require('outbound_channel_configuration');
var defaultClient = OutboundChannelConfiguration.ApiClient.instance;
// Configure HTTP basic authorization: basicAuthentication
var basicAuthentication = defaultClient.authentications['basicAuthentication'];
basicAuthentication.username = 'YOUR USERNAME'
basicAuthentication.password = 'YOUR PASSWORD'

var api = new OutboundChannelConfiguration.TriggersApi()
var integrationKey = integrationKey_example; // {{String}} Unique identifier for an EDMX entity.
var opts = { 
  'integrationMessageId': integrationMessageId_example // {{String}} Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.triggersIntegrationKeyDelete(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TriggersApi();
            var integrationKey = integrationKey_example;  // String | Unique identifier for an EDMX entity.
            var integrationMessageId = integrationMessageId_example;  // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional) 

            try
            {
                // Deletes a trigger.
                apiInstance.triggersIntegrationKeyDelete(integrationKey, integrationMessageId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TriggersApi.triggersIntegrationKeyDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiTriggersApi();
$integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
$integrationMessageId = integrationMessageId_example; // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

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

my $api_instance = WWW::SwaggerClient::TriggersApi->new();
my $integrationKey = integrationKey_example; # String | Unique identifier for an EDMX entity.
my $integrationMessageId = integrationMessageId_example; # String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

eval { 
    $api_instance->triggersIntegrationKeyDelete(integrationKey => $integrationKey, integrationMessageId => $integrationMessageId);
};
if ($@) {
    warn "Exception when calling TriggersApi->triggersIntegrationKeyDelete: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.TriggersApi()
integrationKey = integrationKey_example # String | Unique identifier for an EDMX entity.
integrationMessageId = integrationMessageId_example # String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

try: 
    # Deletes a trigger.
    api_instance.triggers_integration_key_delete(integrationKey, integrationMessageId=integrationMessageId)
except ApiException as e:
    print("Exception when calling TriggersApi->triggersIntegrationKeyDelete: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
Unique identifier for an EDMX entity.
Required
Header parameters
Name Description
integrationMessageId
String
Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request. For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

Responses

Status: 200 - Indicates the Trigger was deleted successfully

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.


triggersIntegrationKeyGet

Retrieves a trigger.

Retrieves a trigger according to the provided integration key. Users can expand deferred properties by specifying them as values to `$expand`.


/Triggers(%27integrationKey%27)

Usage and SDK Samples

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

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

public class TriggersApiExample {

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

        TriggersApi apiInstance = new TriggersApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        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.triggersIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#triggersIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TriggersApi;

public class TriggersApiExample {

    public static void main(String[] args) {
        TriggersApi apiInstance = new TriggersApi();
        String integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
        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.triggersIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#triggersIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *integrationKey = integrationKey_example; // Unique identifier for an EDMX entity.
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)

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

// Retrieves a trigger.
[apiInstance triggersIntegrationKeyGetWith:integrationKey
    $expand:$expand
              completionHandler: ^(Wrapper_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OutboundChannelConfiguration = require('outbound_channel_configuration');
var defaultClient = OutboundChannelConfiguration.ApiClient.instance;
// Configure HTTP basic authorization: basicAuthentication
var basicAuthentication = defaultClient.authentications['basicAuthentication'];
basicAuthentication.username = 'YOUR USERNAME'
basicAuthentication.password = 'YOUR PASSWORD'

var api = new OutboundChannelConfiguration.TriggersApi()
var integrationKey = integrationKey_example; // {{String}} Unique identifier for an EDMX entity.
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.triggersIntegrationKeyGet(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TriggersApi();
            var integrationKey = integrationKey_example;  // String | Unique identifier for an EDMX entity.
            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 a trigger.
                Wrapper_3 result = apiInstance.triggersIntegrationKeyGet(integrationKey, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TriggersApi.triggersIntegrationKeyGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiTriggersApi();
$integrationKey = integrationKey_example; // String | Unique identifier for an EDMX entity.
$$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->triggersIntegrationKeyGet($integrationKey, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TriggersApi->triggersIntegrationKeyGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TriggersApi;
# Configure HTTP basic authorization: basicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::TriggersApi->new();
my $integrationKey = integrationKey_example; # String | Unique identifier for an EDMX entity.
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->triggersIntegrationKeyGet(integrationKey => $integrationKey, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TriggersApi->triggersIntegrationKeyGet: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.TriggersApi()
integrationKey = integrationKey_example # String | Unique identifier for an EDMX entity.
$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 a trigger.
    api_response = api_instance.triggers_integration_key_get(integrationKey, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TriggersApi->triggersIntegrationKeyGet: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
Unique identifier for an EDMX entity.
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 a single Trigger

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 GET operations.


triggersPost

Creates a trigger.

Creates or updates a trigger. Create a trigger by providing the cronjob and a cron expression. The cronjob code, by convention, is the OutboundChannelConfiguration code + CronJob. For example, if the OutboundChannelConfiguration code is `myChannelConfig`, the cronjob code will be `myChannelConfigCronJob`.


/Triggers

Usage and SDK Samples

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

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

public class TriggersApiExample {

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

        TriggersApi apiInstance = new TriggersApi();
        Trigger body = ; // Trigger | 
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            Wrapper_3 result = apiInstance.triggersPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#triggersPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TriggersApi;

public class TriggersApiExample {

    public static void main(String[] args) {
        TriggersApi apiInstance = new TriggersApi();
        Trigger body = ; // Trigger | 
        String prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
        try {
            Wrapper_3 result = apiInstance.triggersPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#triggersPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Trigger *body = ; // 
String *prePersistHook = prePersistHook_example; // Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

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

// Creates a trigger.
[apiInstance triggersPostWith:body
    prePersistHook:prePersistHook
    postPersistHook:postPersistHook
    integrationMessageId:integrationMessageId
              completionHandler: ^(Wrapper_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OutboundChannelConfiguration = require('outbound_channel_configuration');
var defaultClient = OutboundChannelConfiguration.ApiClient.instance;
// Configure HTTP basic authorization: basicAuthentication
var basicAuthentication = defaultClient.authentications['basicAuthentication'];
basicAuthentication.username = 'YOUR USERNAME'
basicAuthentication.password = 'YOUR PASSWORD'

var api = new OutboundChannelConfiguration.TriggersApi()
var body = ; // {{Trigger}} 
var opts = { 
  'prePersistHook': prePersistHook_example // {{String}} Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. For more details,  see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
  'integrationMessageId': integrationMessageId_example // {{String}} Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.triggersPost(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TriggersApi();
            var body = new Trigger(); // Trigger | 
            var prePersistHook = prePersistHook_example;  // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional) 

            try
            {
                // Creates a trigger.
                Wrapper_3 result = apiInstance.triggersPost(body, prePersistHook, postPersistHook, integrationMessageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TriggersApi.triggersPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiTriggersApi();
$body = ; // Trigger | 
$prePersistHook = prePersistHook_example; // String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. For more details,  see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
$integrationMessageId = integrationMessageId_example; // String | Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

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

my $api_instance = WWW::SwaggerClient::TriggersApi->new();
my $body = WWW::SwaggerClient::Object::Trigger->new(); # Trigger | 
my $prePersistHook = prePersistHook_example; # String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).

eval { 
    my $result = $api_instance->triggersPost(body => $body, prePersistHook => $prePersistHook, postPersistHook => $postPersistHook, integrationMessageId => $integrationMessageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TriggersApi->triggersPost: $@\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: basicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.TriggersApi()
body =  # Trigger | 
prePersistHook = prePersistHook_example # String | Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request  persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. 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 that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request.  For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html). (optional)

try: 
    # Creates a trigger.
    api_response = api_instance.triggers_post(body, prePersistHook=prePersistHook, postPersistHook=postPersistHook, integrationMessageId=integrationMessageId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TriggersApi->triggersPost: %s\n" % e)

Parameters

Header parameters
Name Description
Pre-Persist-Hook
String
Name of the pre-persist-hook which is invoked right before the Integration Object sent in the POST or PATCH request persists in the SAP Commerce Cloud system. 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 which is invoked right after the item persists in the SAP Commerce Cloud system. For more details, see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html).
integrationMessageId
String
Header that allows the user to trace any inbound request back to the original POST, PATCH, or DELETE request. For more details, see [inboundrequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html).
Body parameters
Name Description
body *

Responses

Status: 201 - Success response with a single Trigger

Status: 400 - Error responses that may occur when sending a POST request in an attempt to create a new Item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 415 - Provided Media-Type is not supported