IndexIntegrationConfigurations
List integration configurations.
Retrieves a collection of integration configurations.
/saas/v1/orgs/{orgId}/integration-configurations
Usage and SDK Samples
curl -X GET\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/vnd.goa.error"\
"http://localhost:80/saas/v1/orgs/{orgId}/integration-configurations?filter=&orderBy=&skipToken=&paginationLimit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationIntegrationConfigApi;
import java.io.File;
import java.util.*;
public class ApplicationIntegrationConfigApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
ApplicationIntegrationConfigApi apiInstance = new ApplicationIntegrationConfigApi();
String orgId = orgId_example; // String | orgId identifies an organization by given Id.
String filter = filter_example; // String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
String orderBy = orderBy_example; // String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
try {
IntegrationConfigurations result = apiInstance.application_Integration_ConfigIndexIntegrationConfigurations(orgId, filter, orderBy, skipToken, paginationLimit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ApplicationIntegrationConfigApi#application_Integration_ConfigIndexIntegrationConfigurations");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ApplicationIntegrationConfigApi;
public class ApplicationIntegrationConfigApiExample {
public static void main(String[] args) {
ApplicationIntegrationConfigApi apiInstance = new ApplicationIntegrationConfigApi();
String orgId = orgId_example; // String | orgId identifies an organization by given Id.
String filter = filter_example; // String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
String orderBy = orderBy_example; // String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
String skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
String paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
try {
IntegrationConfigurations result = apiInstance.application_Integration_ConfigIndexIntegrationConfigurations(orgId, filter, orderBy, skipToken, paginationLimit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ApplicationIntegrationConfigApi#application_Integration_ConfigIndexIntegrationConfigurations");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
String *orgId = orgId_example; // orgId identifies an organization by given Id.
String *filter = filter_example; // An application id filter to query the integration configurations. Supported fields in the filter are [applicationId] (optional)
String *orderBy = orderBy_example; // The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt]. (optional) (default to createdAt desc)
String *skipToken = skipToken_example; // Used in pagination to point to the next set of records. (optional)
String *paginationLimit = paginationLimit_example; // Custom pagination limit to be used. (optional)
ApplicationIntegrationConfigApi *apiInstance = [[ApplicationIntegrationConfigApi alloc] init];
// List integration configurations.
[apiInstance application_Integration_ConfigIndexIntegrationConfigurationsWith:orgId
filter:filter
orderBy:orderBy
skipToken:skipToken
paginationLimit:paginationLimit
completionHandler: ^(IntegrationConfigurations output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var SaaSManagementFrontService = require('saa_s_management_front_service');
var defaultClient = SaaSManagementFrontService.ApiClient.instance;
var api = new SaaSManagementFrontService.ApplicationIntegrationConfigApi()
var orgId = orgId_example; // {{String}} orgId identifies an organization by given Id.
var opts = {
'filter': filter_example, // {{String}} An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
'orderBy': orderBy_example, // {{String}} The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
'skipToken': skipToken_example, // {{String}} Used in pagination to point to the next set of records.
'paginationLimit': paginationLimit_example // {{String}} Custom pagination limit to be used.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.application_Integration_ConfigIndexIntegrationConfigurations(orgId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class application_Integration_ConfigIndexIntegrationConfigurationsExample
{
public void main()
{
var apiInstance = new ApplicationIntegrationConfigApi();
var orgId = orgId_example; // String | orgId identifies an organization by given Id.
var filter = filter_example; // String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId] (optional)
var orderBy = orderBy_example; // String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt]. (optional) (default to createdAt desc)
var skipToken = skipToken_example; // String | Used in pagination to point to the next set of records. (optional)
var paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used. (optional)
try
{
// List integration configurations.
IntegrationConfigurations result = apiInstance.application_Integration_ConfigIndexIntegrationConfigurations(orgId, filter, orderBy, skipToken, paginationLimit);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ApplicationIntegrationConfigApi.application_Integration_ConfigIndexIntegrationConfigurations: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiApplicationIntegrationConfigApi();
$orgId = orgId_example; // String | orgId identifies an organization by given Id.
$filter = filter_example; // String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
$orderBy = orderBy_example; // String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
$skipToken = skipToken_example; // String | Used in pagination to point to the next set of records.
$paginationLimit = paginationLimit_example; // String | Custom pagination limit to be used.
try {
$result = $api_instance->application_Integration_ConfigIndexIntegrationConfigurations($orgId, $filter, $orderBy, $skipToken, $paginationLimit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ApplicationIntegrationConfigApi->application_Integration_ConfigIndexIntegrationConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationIntegrationConfigApi;
my $api_instance = WWW::SwaggerClient::ApplicationIntegrationConfigApi->new();
my $orgId = orgId_example; # String | orgId identifies an organization by given Id.
my $filter = filter_example; # String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
my $orderBy = orderBy_example; # String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
my $skipToken = skipToken_example; # String | Used in pagination to point to the next set of records.
my $paginationLimit = paginationLimit_example; # String | Custom pagination limit to be used.
eval {
my $result = $api_instance->application_Integration_ConfigIndexIntegrationConfigurations(orgId => $orgId, filter => $filter, orderBy => $orderBy, skipToken => $skipToken, paginationLimit => $paginationLimit);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ApplicationIntegrationConfigApi->application_Integration_ConfigIndexIntegrationConfigurations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ApplicationIntegrationConfigApi()
orgId = orgId_example # String | orgId identifies an organization by given Id.
filter = filter_example # String | An application id filter to query the integration configurations. Supported fields in the filter are [applicationId] (optional)
orderBy = orderBy_example # String | The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt]. (optional) (default to createdAt desc)
skipToken = skipToken_example # String | Used in pagination to point to the next set of records. (optional)
paginationLimit = paginationLimit_example # String | Custom pagination limit to be used. (optional)
try:
# List integration configurations.
api_response = api_instance.application_integration_config_index_integration_configurations(orgId, filter=filter, orderBy=orderBy, skipToken=skipToken, paginationLimit=paginationLimit)
pprint(api_response)
except ApiException as e:
print("Exception when calling ApplicationIntegrationConfigApi->application_Integration_ConfigIndexIntegrationConfigurations: %s\n" % e)
Parameters
Name | Description |
---|---|
orgId* |
String
orgId identifies an organization by given Id.
Required
|
Name | Description |
---|---|
filter |
String
An application id filter to query the integration configurations. Supported fields in the filter are [applicationId]
|
orderBy |
String
The order by filter to sort the integration configurations. Supported fields in the orderBy are [createdAt].
|
skipToken |
String
Used in pagination to point to the next set of records.
|
paginationLimit |
String
Custom pagination limit to be used.
|
Responses
Status: 200 - OK response.
{"nextPage":"/orgs/123/apps/345/integration-configurations?skipToken=b2NjdXJyZWQgZ3QgJzE5NzAtMDEtMDFUMDA6MDA6MDBaJyNvY2N1cnJlZCBkZXNjIzEjNTU2NDg5MDgz","values":[{"applicationId":"123","createdAt":"2018-05-16T16:31:52.1000Z","customFields":"[{\"label\": \"Url\", \"settingsKey\": \"url\"}, {\"label\": \"Apikey\", \"settingsKey\": \"apikey\"}]","extendedSettings":"{\"exchangeType\": \"headers\"}","facets":[{"data":[{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"}],"field":"subAppName"},{"data":[{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"}],"field":"subAppName"}],"groupTaskRequired":true,"imageUrl":"4d87457b19ec858bfafdf0b9f3eccb4cc16d7e0f.png","integrationAuthTypeId":"OAuth2 Client Credentials","integrationPackageName":"metasaas-integration-okta-2.2.6.jar","integrationQueue":"embedded-loader-fsm-production.fifo","isUserMatchingEnabled":true,"settings":"[{\"label\": \"Your Purchaser's Email\", \"settingsKey\": \"username\"}, {\"label\": \"Your Password\", \"settingsKey\": \"password\"}]"},{"applicationId":"123","createdAt":"2018-05-16T16:31:52.1000Z","customFields":"[{\"label\": \"Url\", \"settingsKey\": \"url\"}, {\"label\": \"Apikey\", \"settingsKey\": \"apikey\"}]","extendedSettings":"{\"exchangeType\": \"headers\"}","facets":[{"data":[{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"}],"field":"subAppName"},{"data":[{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"},{"id":"123","name":"O365 Exchange","value":"ENTERPRISEPREMIUM"}],"field":"subAppName"}],"groupTaskRequired":true,"imageUrl":"4d87457b19ec858bfafdf0b9f3eccb4cc16d7e0f.png","integrationAuthTypeId":"OAuth2 Client Credentials","integrationPackageName":"metasaas-integration-okta-2.2.6.jar","integrationQueue":"embedded-loader-fsm-production.fifo","isUserMatchingEnabled":true,"settings":"[{\"label\": \"Your Purchaser's Email\", \"settingsKey\": \"username\"}, {\"label\": \"Your Password\", \"settingsKey\": \"password\"}]"}]}
Status: 400 - Bad Request response.
{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}
Status: 404 - Not Found response.
{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}
Status: 500 - Internal Server Error response.
{"id":"3F1FKVRR","message":"Value of ID must be an integer","name":"bad_request"}